Skip to content

Latest commit

聽

History

History
18 lines (14 loc) 路 1.22 KB

CONTRIBUTING.md

File metadata and controls

18 lines (14 loc) 路 1.22 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via Issue, Discord, Github Discussion, with the owners of this repository before making a change. If it's a new feature the ideal place to discuss is Genie Discussion

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Make sure you remove any OS generated configuration file like macos generates .DS_Store that stores custom attributes
  3. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  4. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  5. You may merge the Pull Request once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer merge it for you.