twentyhq/twenty
1
1
Fork 0
mirror of https://github.com/twentyhq/twenty.git synced 2024-11-23 05:53:31 +03:00
Code Issues Packages Projects Releases Wiki Activity
7b6ee4e0bf
twenty/.github/CONTRIBUTING.md
Nimra Ahmed 7b6ee4e0bf
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
2023-10-07 11:24:44 +02:00

2.7 KiB
Raw Blame History

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.


Getting Started

Before you start contributing, please take a moment to review the following resources:

  • Twenty Repository: The main repository where development takes place.
  • Documentation: Our project documentation to understand the project structure and guidelines.

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.

git clone https://github.com/yourusername/twenty.git
cd twenty
  1. Create a Branch: Create a new branch for your contribution with a descriptive name.
  git checkout -b feature/your-feature-name

  1. Make Changes: Make your desired changes and ensure that your code adheres to our coding standards.

  2. Test Locally: Test your changes locally to ensure they work as expected.

  3. Commit Changes: Commit your changes with a clear and concise commit message.

Copy code
git commit -m "Add your detailed description here"
  1. Push Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name

  1. Create a Pull Request: Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes.

  2. Code Review: Your pull request will undergo a code review. Be prepared to make any necessary adjustments based on feedback.

  3. Merge: Once your pull request is approved, it will be merged into the main repository.


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.


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.


License

By contributing to Twenty, you agree that your contributions will be licensed under the AGPL-3.0 License.

Thank you for considering contributing to Twenty. Your contributions help us make our CRM platform even better!