ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-06-07 19:03:23 +03:00
Code Issues Projects Releases Wiki Activity

Fixed overindented titles

Browse Source
This commit is contained in:
A_D 2021-06-07 12:53:08 +02:00
parent 2fb47377a3
commit 6b7cb2a366
No known key found for this signature in database
GPG Key ID: 4BE9EB7DF45076C4
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Contributing.md
View File

@ -148,7 +148,7 @@ your WIP branch. If there are any non-trivial conflicts when we merge your Pull
to rebase your WIP branch on the latest version of the source branch. Otherwise we'll work out how to best to rebase your WIP branch on the latest version of the source branch. Otherwise we'll work out how to best
merge your changes via comments in the Pull Request. merge your changes via comments in the Pull Request.
### Linting ## Linting
We use flake8 for linting all python source. We use flake8 for linting all python source.
@ -158,7 +158,7 @@ your files.
Note that if your PR does not cleanly (or mostly cleanly) pass a linting scan, your PR may be put on hold pending fixes. Note that if your PR does not cleanly (or mostly cleanly) pass a linting scan, your PR may be put on hold pending fixes.
### Unit testing ## Unit testing
Where possible please write unit tests for your PRs, especially in the case of Where possible please write unit tests for your PRs, especially in the case of
bug fixes, having regression tests help ensure that we don't accidentally bug fixes, having regression tests help ensure that we don't accidentally
@ -362,6 +362,8 @@ literals.
Doc strings are preferred on all new modules, functions, classes, and methods, as they help others understand your code. Doc strings are preferred on all new modules, functions, classes, and methods, as they help others understand your code.
We use the `sphinx` formatting style, which for pycharm users is the default. We use the `sphinx` formatting style, which for pycharm users is the default.
## Comments
### Add comments to LANG usage ### Add comments to LANG usage
Sometimes our translators may need some additional information about what a translation is used for. You can add Sometimes our translators may need some additional information about what a translation is used for. You can add
@ -369,11 +371,17 @@ that information automatically by using `# LANG: your message here`
**on the line directly above your usage, or at the end of the line in your usage**. If both comments exist, the one **on the line directly above your usage, or at the end of the line in your usage**. If both comments exist, the one
on the current line is preferred over the one above on the current line is preferred over the one above
```py
# LANG: this says stuff.
_('stuff')
```
### Mark hacks and workarounds with a specific comment ### Mark hacks and workarounds with a specific comment
We often write hacks or workarounds to make EDMC work on a given version or around a specific bug. We often write hacks or workarounds to make EDMC work on a given version or around a specific bug.
Please mark all hacks, workarounds, magic with one of the following comments, where applicable: Please mark all hacks, workarounds, magic with one of the following comments, where applicable:
```
```py
# HACK $elite-version-number | $date: $description # HACK $elite-version-number | $date: $description
# MAGIC $elite-version-number | $date: $description # MAGIC $elite-version-number | $date: $description
# WORKAROUND $elite-version-number | $date: $description # WORKAROUND $elite-version-number | $date: $description