mukeshs/twenty_crm
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Revised contributing.md, edited docs (#1951)

Browse Source 
* 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

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup
This commit is contained in:
Nimra Ahmed
2023-10-10 15:33:17 +05:00
committed by GitHub
parent 017a0b1563
commit ae32a2da3b
23 changed files with 814 additions and 428 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
.github/CONTRIBUTING.md vendored
View File

@ -1,72 +1,81 @@
# 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.
Thank you for considering contributing to Twenty! We welcome all types of 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. Please make sure to go through the [documentation](https://docs.twenty.com) before making your contribution.
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
> - Star the project
> - Tweet about it
<br>
## Getting Started
Before you start contributing, please take a moment to review the following resources:
Good first issues are a great way to start contributing to the project and get familiar with the codebase. Here's how to find them:
- [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.
1. Visit the "[Issues](https://github.com/twentyhq/twenty/issues)" tab on our [repository](https://github.com/twentyhq/twenty).
2. Use the "Labels" filter and select "[Good First Issue](https://github.com/twentyhq/twenty/labels/good%20first%20issue)" to see a list of beginner-friendly tasks.
3. Choose an issue that interests you, fork the project, and start working on it. Once you solve and test the issue, open a PR and we'll review it.
<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.
3. **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.
4. **Test Locally:** Test your changes locally to ensure they work as expected.
5. **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.
6. **Push Changes:** Push your changes to your forked repository.
```shell
git push origin feature/your-feature-name
git push origin branch-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.
7. **Create a Pull Request:** Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes. To accept your pull request, we need you to sign a CLA.
8. **Code Review:** Your pull request will undergo a code review. Be prepared to make any necessary adjustments based on feedback.
9. **Merge:** Once your pull request is approved, it will be merged into the main repository.
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
Thank you for considering contributing to Twenty. Your contributions help us make our CRM platform even better!
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!