[go: up one dir, main page]
Skip to content

Latest commit

 

History

History
70 lines (39 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

70 lines (39 loc) · 2.36 KB
Raw

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

Having multiple contributors address the same issue can cause frustration.

To avoid conflicts, we follow these guidelines:

  1. If a core team member assigned you the issue within the last three days, your PR takes priority.
  2. Otherwise, the first submitted PR is prioritized.
  3. For "size: long" PRs, the assignment period extends to one week.

Please ensure you're assigned to an issue before starting work.

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)[https://github.com/twentyhq/twenty/issues/new]. Please provide as much detail as possible.