We're so excited that you're considering contributing to this project! Community contributions are what make open-source projects so valuable, and we're thrilled to have you on board.
-
Fork the Repository: The first step to contributing is to fork the repository to your own GitHub account. This allows you to freely experiment with changes without affecting the original project.
-
Clone Your Fork Locally: Once you've forked the repository, you can clone it to your local machine to work on it.
git clone https://github.com/cytex-ch/klara-js.git -
Create a Branch: Always create a new branch for each feature or fix you're working on. This keeps your contributions clean and organized.
git checkout -b [branch-name] -
Commit Your Changes: After you've made changes, commit them with a clear and concise commit message.
git commit -m "Add a new feature" -
Push Changes: Push your changes back to your fork on GitHub.
git push origin [branch-name] -
Submit a Pull Request (PR): Go to the original repository on GitHub and click the "New pull request" button. Choose the branch from your fork to merge into the main branch of the original repository.
-
No Direct Pushes: To maintain code integrity, we do not allow direct pushes to the main repository. All changes must be submitted via pull requests and reviewed.
-
Communicate: If you're working on a significant change or a new feature, we highly recommend getting in touch with us before you start. This will help prevent duplication of work and make sure everyone is aligned.
We're at an early stage in this project, and your thoughts and ideas are extremely valuable to us. Feel free to open an issue to share your suggestions or get clarification on something. We love hearing from our community!
Thank you for your interest in contributing to our project! We look forward to collaborating with you.