We’re excited that you’re interested in contributing to Reef Support! Your contributions help us create tools to protect marine ecosystems and empower conservation efforts worldwide.
We welcome contributions in various forms:
- Reporting bugs 🐛
- Suggesting new features 🌟
- Improving documentation 📝
- Submitting code contributions 💻
- Sharing feedback and ideas 💡
- Navigate to the Reef Support repository you want to contribute to.
- Click the "Fork" button in the top-right corner to create your own copy.
Use the following command to clone your forked repository to your local machine:
git clone https://github.com/<your-username>/<repository-name>.gitBefore making changes, create a new branch:
git checkout -b feature/your-feature-name- Ensure your code follows our style guidelines.
- Write clear, concise commit messages.
- Include tests if your contribution involves code.
Push your branch to your forked repository:
git add .
git commit -m "Brief description of changes"
git push origin feature/your-feature-name- Go to the original repository on GitHub.
- Click the "Pull Request" tab, then "New Pull Request."
- Select your branch and describe your changes.
- File Structure: Follow the existing folder and file structure.
- Code Style:
- Use meaningful variable and function names.
- Ensure your code is well-commented and easy to understand.
- Testing:
- If applicable, write tests for your changes and ensure all tests pass.
- Documentation:
- Update or add relevant documentation for your changes.
- Ensure README files and other docs are clear and concise.
If you encounter issues or have questions, feel free to:
- Open an issue on GitHub.
- Contact us at yohan@reef.support.
Thank you for your contributions to Reef Support! Together, we can protect our oceans. 🌊