twentyhq/twenty
1
1
Fork 0
mirror of https://github.com/twentyhq/twenty.git synced 2024-11-22 21:50:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
1cd91e60fa
twenty/.github/CONTRIBUTING.md
Nimra Ahmed 1cd91e60fa
Doc changes (#2106) 
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md
2023-10-18 18:00:52 +02:00

3.1 KiB
Raw Blame History

Contributing to Twenty

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

Getting Started

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:

  1. Visit the "Issues" tab on our repository.
  2. Use the "Labels" filter and select "Good First Issue" 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.

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

git commit -m "Add your detailed description here"
  1. Push Changes: Push your changes to your forked repository.
git push origin 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. To accept your pull request, we need you to sign a CLA.

  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.


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, friendly, and inclusive community for all contributors.


Reporting Issues

If you encounter any issues or have suggestions for improvements, please feel free to (create an issue on our GitHub repository)[https://github.com/twentyhq/twenty/issues/new]. When reporting issues, please provide as much detail as possible to help us understand and address the problem effectively.

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