external/aurweb
0
0
Fork 0
mirror of https://gitlab.archlinux.org/archlinux/aurweb.git synced 2025-02-03 10:43:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: merge CodingGuidelines into CONTRIBUTING.md

Browse source 
Signed-off-by: Kevin Morris <kevr@0cost.org>
This commit is contained in:
Kevin Morris 2022-02-23 18:54:35 -08:00
parent 25d74d02c7
commit 1bb4daa36a
No known key found for this signature in database
GPG key ID: F7E46DED420788F3
2 changed files with 13 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -1,6 +1,7 @@
# Contributing
Patches should be sent to the [aur-dev@lists.archlinux.org][1] mailing list.
Patches should be sent to the [aur-dev@lists.archlinux.org][1] mailing list
or included in a merge request on the [aurweb repository][2].
Before sending patches, you are recommended to run `flake8` and `isort`.
@ -8,12 +9,20 @@ You can add a git hook to do this by installing `python-pre-commit` and running
`pre-commit install`.
[1]: https://lists.archlinux.org/listinfo/aur-dev
[2]: https://gitlab.archlinunx.org/archlinux/aurweb
### Coding Guidelines
1. All source modified or added within a patchset **must** maintain equivalent
or increased coverage by providing tests that use the functionality.
DISCLAIMER: We realise the code doesn't necessarily follow all the rules.
This is an attempt to establish a standard coding style for future
development.
2. Please keep your source within an 80 column width.
1. All source modified or added within a patchset **must** maintain equivalent
or increased coverage by providing tests that use the functionality
2. Please keep your source within an 80 column width
3. Use four space indentation
4. Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
5. DRY: Don't Repeat Yourself
6. All code should be tested for good _and_ bad cases
Test patches that increase coverage in the codebase are always welcome.