Contributing

Community

Configurator has a discord server where we discuss open issues and help newcomers to contribute more easily. Feautre requests and rearchitectural proposals are discussed here before making version updates. We are still a growing community and people of all skill levels are welcomed to join and contribute in whichever way possible.

Areas you can help out

  1. Ask if you can help write a new feature
  2. Automate project setup
  3. Help maintain the project
  4. Help moderate the discussion boards or conversation channels
  5. Write and improve the project’s documentation
  6. Link to duplicate issues, and suggest new issue labels, to keep things organized
  7. Write a translation for the project’s documentation
  8. Organize workshops or meetups about the project

Making changes

When contributing to this repository, please first discuss the change you wish to make via issue, discord, or any other method with the owners of this repository before making a change.

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

  1. If you notice a bug or have a useful feature in mind raise an issue in the issue tracker or mention it in the discord server.

  2. Label issues accordingly in the issue tracker

Pull Request Process

  1. We follow the standard ‘Fork and Pull’ workflow.
  2. Fetch the latest code from master branch and resolve any conflicts before sending a pull request.
  3. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  4. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  5. 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.
  6. Request the project maintainers to merge a pull request for you either through e-mail or on the discord server.