The Indoor Scene Detector project welcomes all contributions!
Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Please make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
git commit -m "prefix: A brief summary of the commit
>
> A paragraph describing what changed and its impact"Please prefix your commits with one of the following, as appropriate:
feat: (new feature for the user, not a new feature for build script)fix: (bug fix for the user, not a fix to a build script)docs: (changes to the documentation)style: (formatting, missing semi colons, etc)refactor: (refactoring production code, eg. renaming a variable)test: (adding missing tests, refactoring tests)chore: (updating grunt tasks etc)
Python
- This project uses the Black code style, please ensure that your code adheres to this.
- For docstrings the NumPy style is used, please ensure that your code documentation adheres to this.
This contributing file was inspired by opengovernment.