Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.86 KB
Raw

Contributing to [Certy]

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to [Project Name]. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please create an issue on GitHub. Be sure to include:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual results
  • Any relevant logs or screenshots

Suggesting Enhancements

If you have an idea to improve the project, please create an issue on GitHub. Describe the enhancement in detail and provide any relevant examples or documentation.

Submitting Pull Requests

Before Submitting a Pull Request

  • Fork the repository and create your branch from main.
  • Ensure that your changes pass the existing tests and add new tests if necessary.
  • Ensure that your code adheres to the project's coding standards and style.
  • Update the documentation if necessary.

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 with details of changes to the interface, this includes 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. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in 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 to merge it for you.

Coding Standards

  • Follow the existing code style.
  • Write clear and concise commit messages.
  • Document your code where necessary.