Files
twenty/.github/CONTRIBUTING.md
Ansh Grover 7620e1b0a6 Fix markdown link formatting in CONTRIBUTING.md (#16176)
CC: @FelixMalfait 

Before: 
<img width="1293" height="170" alt="image"
src="https://github.com/user-attachments/assets/dc02afea-2781-4a5b-885a-2617709d9e36"
/>

After: 
<img width="1293" height="170" alt="image"
src="https://github.com/user-attachments/assets/acbc5c0b-bb96-4cd7-8c02-892cc4745f70"
/>
2025-11-28 13:53:45 +01:00

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:

  1. For Good First Issue and Experienced Contributor issues without size: long labels, we'll merge the first PRs that meet our code quality standards. We don't assign contributors to these issues. For priority: high issues, our core team will step in within days if no adequate contributions are received.
  2. For size: long Issues, assigned contributors have one week to submit their first draft PR.

How to Contribute

  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 New Branch: Create a new branch for your changes instead of using the main branch.
git checkout -b your-branch-name
  1. Make Changes: Make your desired changes and ensure that your code adheres to Twenty's 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.

git commit -m "Add your detailed description here"
  1. Push Changes: Push your changes to your forked repository.
git push origin your-branch-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. Submitting a PR means you agree to the CLA.

  2. Code Review: Your pull request will undergo a code review.

  3. 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.