Update README and Documentation (#1875)

* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review
This commit is contained in:
Nimra Ahmed
2023-10-07 14:24:44 +05:00
committed by GitHub
parent da68654caf
commit 7b6ee4e0bf
22 changed files with 14485 additions and 478 deletions

72
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,72 @@
# Contributing to Twenty
Thank you for considering contributing to Twenty! We welcome contributions from the community to help us build and improve our open-source CRM platform. This guide outlines the process for contributing to our project.
<br>
## Getting Started
Before you start contributing, please take a moment to review the following resources:
- [Twenty Repository](https://github.com/twentyhq/twenty): The main repository where development takes place.
- [Documentation](https://docs.twenty.com): Our project documentation to understand the project structure and guidelines.
<br>
## Contributing Guidelines
1. **Fork the Repository:** Click on the 'Fork' button in the upper right corner of the repository's GitHub page. This will create a copy of the repository in your GitHub account.
2. **Clone the Repository:** Clone your forked repository to your local machine using `git clone`.
```shell
git clone https://github.com/yourusername/twenty.git
cd twenty
```
3. **Create a Branch:** Create a new branch for your contribution with a descriptive name.
```shell
git checkout -b feature/your-feature-name
```
4. **Make Changes:** Make your desired changes and ensure that your code adheres to our coding standards.
5. **Test Locally:** Test your changes locally to ensure they work as expected.
6. **Commit Changes:** Commit your changes with a clear and concise commit message.
```shell
Copy code
git commit -m "Add your detailed description here"
```
7. **Push Changes:** Push your changes to your forked repository.
```shell
git push origin feature/your-feature-name
```
8. **Create a Pull Request:** Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes.
9. **Code Review:** Your pull request will undergo a code review. Be prepared to make any necessary adjustments based on feedback.
10. **Merge:** Once your pull request is approved, it will be merged into the main repository.
<br>
## Reporting Issues
If you encounter any issues or have suggestions for improvements, please feel free to create an issue on our GitHub repository. When reporting issues, please provide as much detail as possible to help us understand and address the problem effectively.
<br>
## Code of Conduct
Please note that by contributing to this project, you are expected to follow our Code of Conduct. We strive to maintain a welcoming and inclusive community for all contributors.
<br>
## License
By contributing to Twenty, you agree that your contributions will be licensed under the [AGPL-3.0 License](https://github.com/twentyhq/twenty/blob/main/LICENSE).
Thank you for considering contributing to Twenty. Your contributions help us make our CRM platform even better!

31
.github/SECURITY.md vendored Normal file
View File

@ -0,0 +1,31 @@
# Security Policy
## Reporting a Vulnerability
We strongly encourage reporting any potential vulnerabilities.
If you suspect a vulnerability, please take the following steps:
- Contact us immediately at `security at twenty.com`.
- Include a comprehensive description of the potential vulnerability and steps to reproduce the issue, if possible. The more information you can provide, the quicker we can address the problem.
Our commitment is to respond to your initial report within one business day.
While we're addressing the issue, we kindly request you to maintain confidentiality about the vulnerability to ensure the security of all users.
Please refrain from exploiting the vulnerability or revealing the problem to others.
While we don't currently have a formal bug bounty program due to the project's nascent stage, we can assure you that:
- Your report will be responded to within one business day.
- Your report and all accompanying data will be handled with utmost confidentiality.
- We greatly appreciate your contribution and would be happy to acknowledge your role in the vulnerability fix, should you choose to be identified.
- We will grant you permission to publicly discuss your findings after the patch has been released and a reasonable time has passed for users to implement it.
- We (obviously) guarantee that we will not pursue any legal action as long as the vulnerability is not exploited.
## Security Features
We are always looking for ways to improve our product's security.
If you have any recommendations or feature request that could enhance the product's security, we invite you to share them with us via the dicsussion forum.
⚠️ Note this does not apply to security vulnerabilities. If you're in doubt, then always follow the security vulnerability process