mirror of https://github.com/m-labs/artiq.git synced 2024-12-31 06:03:34 +08:00

David Nadlinger 91f0d640e2

.github: Match suggested commit message format to established convention

This changes the suggested format for commit messages to match the
convention actually used here (no square brackets).

2018-10-25 22:01:14 +01:00

2.7 KiB

Raw Blame History

ARTIQ Pull Request

Description of Changes

Type of Changes

	Type
✓	🐛 Bug fix
✓	✨ New feature
✓	🔨 Refactoring
✓	📜 Docs

Steps (Choose relevant, delete irrelevant before submitting)

All Pull Requests

Use correct spelling and grammar.
Update RELEASE_NOTES.md if there are noteworthy changes, especially if there are changes to existing APIs.
Close/update issues.
Check the copyright situation of your changes and sign off your patches (git commit --signoff, see copyright).

Code Changes

Run flake8 to check code style (follow PEP-8 style). flake8 has issues with parsing Migen/gateware code, ignore as necessary.
Test your changes or have someone test them. Mention what was tested and how.
Add and check docstrings and comments
Check, test, and update the conda recipes in conda/
Check, test, and update the unittests in /artiq/test/ or gateware simulations in /artiq/gateware/test

Documentation Changes

Check, test, and update the documentation in doc/. Build documentation (cd doc/manual/; make html) to ensure no errors.

Git Logistics

Split your contribution into logically separate changes (git rebase --interactive). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See tutorial.
Write short & meaningful commit messages. Review each commit for messages (git show). Format:
```
topic: description. < 50 characters total.

Longer description. < 70 characters per line
```

Licensing

See copyright & licensing for more info. ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.

2.7 KiB Raw Blame History