Skip to content

Contributing

Nevio Vesic edited this page Mar 28, 2024 · 4 revisions

Contributing to SolGo

First and foremost, thank you for considering contributing to SolGo! 🎉 Every contribution, no matter how small, is valuable and helps improve the project.

Table of Contents

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please ensure you read and understand it before contributing.

Getting Started

  1. Fork the Repository: Click on the 'Fork' button at the top right corner of the SolGo repository.
  2. Clone the Forked Repository: git clone https://github.com/YOUR_USERNAME/solgo.git
  3. Navigate to the Directory: cd solgo
  4. Create a New Branch: git checkout -b your-branch-name
  5. Make Your Changes: Add, edit, or delete files as necessary.
  6. Commit Your Changes: git commit -m "Brief description of your changes"
  7. Push to GitHub: git push origin your-branch-name
  8. Open a Pull Request: Go to the SolGo repository and click on 'New Pull Request'.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md or relevant documentation with details of changes, including new environment variables, exposed ports, useful file locations, and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  4. Your Pull Request will be reviewed by the maintainers. Address any comments or requested changes promptly.

Reporting Bugs

If you encounter any bugs or issues, please create a new issue with a detailed description, and label it as a bug.

Suggesting Enhancements

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.

Community

Discord: Invite Link


Thank you for being a part of the SolGo community and for contributing to its growth and improvement! 🚀