Thank you for considering contributing to our project! We welcome contributions from everyone. To ensure a smooth process, please follow the guidelines below.
If you find a bug or have a feature request, please open an issue in our issue tracker. Be sure to include as much detail as possible.
If you'd like to contribute code, please follow these steps:
- Fork the Repository: Click the "Fork" button at the top right corner of the repository page.
- Clone Your Fork: Use the following command to clone your fork to your local machine:
git clone https://github.com/hhs-coding-club/recubed.git
- Create a Branch: Create a new branch for your changes:
git checkout -b your-branch-name
- Make Your Changes: Make the necessary changes to the codebase.
- Commit Your Changes: Write a clear and concise commit message:
git commit -m "Description of changes"
- Push Your Changes: Push your changes to your fork:
git push origin your-branch-name
Once your changes are pushed, open a pull
request against the main branch of the original repository. Provide a clear description of the changes you've made and reference any related issues.
We expect all contributors to adhere to our Code of Conduct. Please treat everyone with respect and kindness.