Contributing
Nevio Vesic edited this page Mar 28, 2024
·
4 revisions
First and foremost, thank you for considering contributing to SolGo! 🎉 Every contribution, no matter how small, is valuable and helps improve the project.
- Code of Conduct
- Getting Started
- Pull Request Process
- Reporting Bugs
- Suggesting Enhancements
- Community
By participating in this project, you are expected to uphold our Code of Conduct. Please ensure you read and understand it before contributing.
- Fork the Repository: Click on the 'Fork' button at the top right corner of the SolGo repository.
-
Clone the Forked Repository:
git clone https://github.com/YOUR_USERNAME/solgo.git -
Navigate to the Directory:
cd solgo -
Create a New Branch:
git checkout -b your-branch-name - Make Your Changes: Add, edit, or delete files as necessary.
-
Commit Your Changes:
git commit -m "Brief description of your changes" -
Push to GitHub:
git push origin your-branch-name - Open a Pull Request: Go to the SolGo repository and click on 'New Pull Request'.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md or relevant documentation with details of changes, including new environment variables, exposed ports, useful file locations, and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
- Your Pull Request will be reviewed by the maintainers. Address any comments or requested changes promptly.
If you encounter any bugs or issues, please create a new issue with a detailed description, and label it as a bug.
We love receiving suggestions! If you have an idea for an enhancement or a new feature, open a new issue and label it as an enhancement.
Discord: Invite Link
Thank you for being a part of the SolGo community and for contributing to its growth and improvement! 🚀