Welcome! Thank you for wanting to contribute to Genestack!
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. However, if you see a problem, feel free to fix it.
- Please fork the repository and create a feature/modification branch. GitHub makes this easy.
- Test your changes! -- If you are making changes to the general Genestack repo, do a clean build from scratch. If you are changing the docs, then rebuild the docs from scratch and lint your Markdown. (You can use this to simply check for trailing spaces, or you can go full Markdown Lint on it.
- Once your branch builds, make sure you're caught-up to main and rebase if necessary.
- We are trying to use Conventional Commits for our repository. This allows us to have an easy way to tell what each commit is trying to achieve, and will speed reviews.
- This cheatsheet can be helpful to keep around to use to make commits easy.
- Keep your changes atomic. Smaller commits centered around specific changes are easier to merge than big "jumbo" commits that touch things in many places.
- Commits need to be signed and will need to show up as verified in GitHub.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Make sure you haven't added any extraneous files to the repository (secrets, .DS_Store, etc.) and double-check .gitignore if you have a new type of change.
- Update the README.md / Wiki with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- You may merge the Pull Request in once you have the sign-off of one other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.