Skip to content

Latest commit

 

History

History
executable file
·
117 lines (73 loc) · 4.94 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
117 lines (73 loc) · 4.94 KB
Raw

Contributing

🎉 If you want to contribute this project thanks for taking the time on it and wish you to have fun. Please do not forget to add a short yourself info in the section Authors after contributing this project.

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.

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

Contributing Factors

🐞 Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
  • Provide test images, which can be used for reproducing.

Bug Report Template

For the creating Issues, please see this template.

name about title labels assignees
Bug report Create a report to help us improve

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context Add any other context about the problem here.

🩹 Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.

🎈 Did you fix whitespace, format code, or make a purely cosmetic patch?

  • Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of this project - you are welcome.

⚙️ Do you intend to add a new feature or change an existing one?

  • Suggest your change in the feature request and wait for approval to avoid writing code, which won't be added.
  • Do not open a pull request on GitHub until you have collected positive feedback about the change.

Feature Request Template

For the creating feature request, please see this template.

name about title labels assignees
Feature request Suggest an idea for this project

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Pull Request Process

  1. Update the readme file and changelog file with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  2. Increase the version numbers in any examples files, the readme file, the changelog file, and also badges (if it is needed) to the new version that this pull request would represent. For the versioning is used Semantic Versioning.
  3. You may merge the pull request in once you have the sign-off of one or more other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Pull Request Checklist

For any pull request, please refer to this checklist.

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Make sure you are requesting to pull a topic/feature/bugfix branch (right side). Don't request your master!
  • Make sure you are making a pull request against the master branch (left side).
  • Check the commit's or even all commits' message styles matches our requested structure.
  • Check your code additions will fail neither code linting checks nor unit test.