e7da97194a
2.4 KiB
Contributing to Twenty
Thanks for considering contributing to Twenty!
Please make sure to go through the documentation before.
Good first issues
Good first issues are a great way to start contributing and get familiar with the codebase. You can find them on by filtering on the good first issue label.
Issue assignment
To avoid conflicts, we follow these guidelines:
- For
Good First IssueandExperienced Contributorissues withoutsize: longlabels, we'll merge the first PRs that meet our code quality standards. We don't assign contributors to these issues. Forpriority: highissues, our core team will step in within days if no adequate contributions are received. - For
size: longIssues, assigned contributors have one week to submit their first draft PR.
How to Contribute
-
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.
-
Clone the Repository: Clone your forked repository to your local machine using
git clone.
git clone https://github.com/yourusername/twenty.git
cd twenty
- Create a New Branch: Create a new branch for your changes instead of using the main branch.
git checkout -b your-branch-name
-
Make Changes: Make your desired changes and ensure that your code adheres to Twenty's coding standards.
-
Test Locally: Test your changes locally to ensure they work as expected.
-
Commit Changes: Commit your changes with a clear and concise commit message.
git commit -m "Add your detailed description here"
- Push Changes: Push your changes to your forked repository.
git push origin your-branch-name
-
Create a Pull Request: Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes. Submitting a PR means you agree to the CLA.
-
Code Review: Your pull request will undergo a code review.
-
Merge: Once approved, maintainers will merge your pull request into the main repository.
Reporting Issues
If you face any issues or have suggestions, please feel free to create an issue on Twenty's GitHub repository. Please provide as much detail as possible.