Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
AlekSIS-Core
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AlekSIS®
Official
AlekSIS-Core
Commits
5b10db95
Verified
Commit
5b10db95
authored
5 years ago
by
Nik | Klampfradler
Browse files
Options
Downloads
Patches
Plain Diff
Update coding style guidelines
Closes
#117
.
parent
4d8d36b1
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.rst
+11
-3
11 additions, 3 deletions
CONTRIBUTING.rst
with
11 additions
and
3 deletions
CONTRIBUTING.rst
+
11
−
3
View file @
5b10db95
...
...
@@ -12,22 +12,30 @@ Coding layout and style
The coding style is defined in `PEP 8`_, with the following differences and
decisions:
- The defaults of the `black`_ code formatter are used
- This implies all string literals usin double-quotes, if it does not lead
to more escaping. As proposed by `black`: "My recommendation here is to
keep using whatever is faster to type and let Black handle the transformation."
- The maximum line length is 100 characters
- Imports are structured in five blocks, each of them sorted as defined in
PEP 8:
PEP 8
and the Django style guide
:
1. Standard library imports
2. Django imports
3. Third-party imports
4. Imports from
other
BiscuIT apps (absolute imports)
4. Imports from BiscuIT
core and other
apps (absolute imports)
5. Imports from the same BiscuIT app (realtive imports)
- All string literals use single quote
s
Use `isort` to take care of thi
s
For the layout of source trees and style recommendations specific to Django,
the `Django coding style`_ is a good source of information, together with
the `Django Best Practices`_ collection.
To ensure code is styled correctly, before commiting, run::
tox -e reformat
Working with the Git repository
-------------------------------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment