Athanasius
9dcb79a5db
Contributing: Minor grammar/punctuation
2021-06-07 12:11:58 +01:00
Athanasius
54b57db329
Contributing: <type>/<issue number>/<title> now mandated
2021-06-07 12:10:43 +01:00
Athanasius
3edf4ed069
Contributing: re-format 'Work on Issues'
2021-06-07 12:04:14 +01:00
A_D
6b7cb2a366
Fixed overindented titles
2021-06-07 12:54:01 +02:00
A_D
9c4bc182ca
Added LANG file generation and comment extraction
2021-06-07 12:43:16 +02:00
Athanasius
3975aa3e87
Contributing: Choose an appropriate logging level
...
Open to comments on my definitions.
2021-06-07 11:16:02 +01:00
Athanasius
f6f5a8a8fe
Contributing: Fix header levels after 'Scope changes'
2021-06-07 11:03:41 +01:00
A_D
cd8319bfc6
Clarify size of giant
2021-05-27 11:18:31 +02:00
A_D
4643d95f26
Add HACK/MAGIC/WORKAROUND comments
2021-05-27 10:27:25 +02:00
Athanasius
e0574e5584
Contributing.md: Minor pytest-related edits
...
* URL-ise some things.
* `` around some code.
2021-04-01 14:45:52 +01:00
Athanasius
0cae22e4a4
Contributing.md: Expand on unit test docs & set vim wordwrap.
...
* vim: modeline for 79 character line wrap
* Add some hints about running tests.
* Pointer to the pytest docs.
2021-04-01 14:45:52 +01:00
Athanasius
3a80d77997
Contributing.md: We use pytest
and a particular file layout for tests.
2021-04-01 14:45:52 +01:00
A_D
ee12b2073c
fixed some sentence construction
2020-09-09 23:23:15 +02:00
A_D
b50ed893ae
Cleaned up and updated Contributing docs
2020-09-09 17:12:44 +02:00
Athanasius
3438867ad3
Docs: Reference Bug Report Template if applicable, not general issue URL.
2020-09-06 10:24:30 +01:00
Athanasius
66e2c354c7
Documentation update and getLogger() -> get_logger()
...
* Technically %(class)s can be e.g. A.B not just 'B' so say "name(s)".
* To not confuse EDMCLogging.getLogger() with logging.getLogger() it's
been renamed to get_logger().
* Note how we signal errors with finding class and/or qualname.
* Call out EDMCLogging.py in Contributing.md.
2020-07-27 06:57:53 +01:00
Athanasius
a82824c0e9
Contributing.md: Update logging docs for auto qualname and proper import
2020-07-27 06:57:52 +01:00
Athanasius
fa1443b49c
Contributing.md: Document use of logging.
...
Also fixes some camelCase to be proper snake_case in an example.
2020-07-27 06:57:23 +01:00
A_D
836a27fb96
Fixed code blocks
2020-07-24 13:45:17 +01:00
A_D
f3d2098179
Updated docs
...
Added linting, testing, and new requirements-dev.txt instructions
2020-07-24 13:45:17 +01:00
Athanasius
329ef42867
Contributing.md: Fixups
...
* Reference to Version Strings doesn't need 'URL' as text.
* We're in docs, so just 'Contributing.md'.
* Changelog.md is in parent directory.
2020-07-19 15:11:17 +01:00
Athanasius
bdec515ee2
Contributing.md: We're now using Semantic Version strings.
...
* Add/correct links to Releasing.md.
* Pre-releases must have tags of the correct form now.
* Misc formatting changes, mostly adding a <hr/> between sections.
2020-07-19 15:04:22 +01:00
Athanasius
84da527587
Changed to 'Version Strings' in Releasing.md
2020-07-19 12:40:50 +01:00
Athanasius
3138407e98
Contributing.md: Reference Releasing.md for version string format
2020-07-19 12:38:19 +01:00
Athanasius
09be5505bc
Clarify what stable and beta branches may contain. Describe release tags.
...
* Both `stable` and `beta` might contain extra commits for hotfixes beyond
what is currently released.
* Describe the Stable Release tag form, and point out that currently
the pre-release tag form is the same.
2020-07-15 11:48:33 +01:00
Athanasius
1781b6657c
Contributing.md: beta can lag behind main/stable/develop
2020-07-15 11:48:33 +01:00
Athanasius
996f317130
Contributing.md: master
is deprecated, use main
.
2020-07-15 11:48:33 +01:00
Athanasius
ea0d6471d2
Contributing.md: Fix 'contentions' typo
2020-07-13 12:04:44 +01:00
Athanasius
d4706a053e
We now use 'main' instead of 'master' in place of 'develop'
...
After 4.0.0.0 we need to not have 'develop' as default branch, so change it
now, and migrate to 'main' instead of 'master' whilst we're at it.
2020-07-10 11:07:45 +01:00
Athanasius
65793bce24
Contributing.md: develop is default branch, XXX- issue number optional
2020-07-06 16:05:09 +01:00
Athanasius
71cc41b39a
We're not following Semantic Versioning to the letter.
...
We might in the future, but that would depend on changes to `setup.py` to make it only `A.B.C`
and to add support for extra strings.
2020-06-30 19:20:30 +01:00
Athanasius
d0fdfaed0b
RELEASING.md is no longer shouted.
2020-06-30 16:44:29 +01:00
Athanasius
37a0195de4
Adds Contributing.md
...
* Outlines everything a new contributor should know.
* There's one 'XXX' to-check items with regards to Windows Installer,
and if it does think A.B.C.1 should be installed in place of A.B.C.0.
Closes #533
2020-06-30 16:30:05 +01:00