diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..fc8d994 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +Contributions to LXC ID Mapper are always welcome but please try to follow these guidelines when sending in something as it will help addressing the issue quicker and more smoothly. + +## Code of Conduct + +Contributors are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). + +## Submit an issue + +Before submitting a new issues, try searching for a similar one and add your scenario there and anything else which you think will help with fixing it; + +If you are filing a bug report, regression issue or what it appears to be strange behaviour, please follow the steps below: + +1. Please write an elaborate title which explains the problem as accurate as possible +2. Include a sample test which reproduces the problem you're experiencing. +3. Include the verbose output. +4. Include your configuration (try to leave out the irrelevant bits); + +## Submitting a pull request + +Thanks in advance for your contribution. + +1. Follow the coding style of the project. +2. If you're fixing a bug, also create an issue if one doesn't exist yet. +3. If it's a new feature/enhancement, explain why do you think it's necessary. +4. If your change include drastic or low level changes please discuss them to make sure they will be accepted and what the impact will be. +5. If your change is based on existing functionality, please consider refactoring first. Pull requests that duplicate code will not make it in very quick, if at all. +6. Do not include changes that are not related to the issue at hand. +7. Follow the same coding style in regard to spaces, semicolons, variable naming etc. +8. Always add tests - after all this is a testing framework.