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
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -1,6 +1,7 @@
# Contributing # 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`. 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`. `pre-commit install`.
[1]: https://lists.archlinux.org/listinfo/aur-dev [1]: https://lists.archlinux.org/listinfo/aur-dev
[2]: https://gitlab.archlinunx.org/archlinux/aurweb
### Coding Guidelines ### Coding Guidelines
1. All source modified or added within a patchset **must** maintain equivalent DISCLAIMER: We realise the code doesn't necessarily follow all the rules.
or increased coverage by providing tests that use the functionality. 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. Test patches that increase coverage in the codebase are always welcome.

54
doc/CodingGuidelines
View file

@ -1,54 +0,0 @@
Coding Guidelines
=================
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.
Coding style
------------
Column width: 79 columns or less within reason.
Indentation: tabs (standard eight column width)
Please don't add any mode lines. Adjust your editor to display tabs to your
preferred width. Generally code should work with the standard eight column
tabs.
No short open tags. '<?'
Do not end files with a close tag. '?>'
Try embedding as little XHTML in the PHP as possible.
Consider creating templates for XHTML.
All markup should conform to XHTML 1.0 Strict requirements.
You can use http://validator.w3.org to check the markup.
Prevent PHP Notices by using isset() or empty() in conditionals that
reference $_GET, $_POST, or $_REQUEST variables.
MySQL queries should generally go into functions.
Submitting patches
------------------
!!! PLEASE TEST YOUR PATCHES BEFORE SUBMITTING !!!
Submit uncompressed git-formatted patches to aur-dev@archlinux.org.
You will need to register on the mailing list before submitting:
https://mailman.archlinux.org/mailman/listinfo/aur-dev
Base your patches on the master branch as forward development is done there.
When writing patches please keep unnecessary changes to a minimum.
Try to keep your commits small and focused.
Smaller patches are much easier to review and have a better chance of being
pushed more quickly into the main repo. Smaller commits also makes reviewing
the commit history and tracking down specific changes much easier.
Try to make your commit messages brief but descriptive.
Glossary
--------
git-formatted patch:
A patch that is produced via `git format-patch` and is sent via
`git send-email` or as an inline attachment of an email.