mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

Further updates to contributing guidelines

Browse Source
This commit is contained in:
jeremy@jermolene.com 2021-04-02 14:39:29 +01:00
parent c976aad5e0
commit 013218b852
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
editions/tw5.com/tiddlers/community/Contributing.tid
View File

@ -15,15 +15,31 @@ PRs must meet these minimum requirements before they can be considered for mergi
** The material must be licensed under a license compatible with TiddlyWiki's BSD license ** The material must be licensed under a license compatible with TiddlyWiki's BSD license
* The author must sign the Contributors License Agreement (see below) * The author must sign the Contributors License Agreement (see below)
* Each PR should only make a single feature change * Each PR should only make a single feature change
* The title of the PR should be 50 characters or less
* The title of the PR should be capitalised, and should not end with a period
* The title of the PR should be written in the imperative mood. See below
* Adequate explanation in the body of the PR for the motivation and implementation of the change. Focus on the //why// and //what//, rather than the //how//
* PRs must be self-contained. Although they can link to material elsewhere, everything needed to understand the intention of the PR should be included * PRs must be self-contained. Although they can link to material elsewhere, everything needed to understand the intention of the PR should be included
* Adequate narrative to explain the motivation and implementation of the change
* Documentation as appropriate for end-users or developers * Documentation as appropriate for end-users or developers
* Observe the coding style * Observe the coding style
* Read the developers documentation * Read the developers documentation
* Please open a consultation issue prior to investing time in making a large PR
Finally, please open a consultation issue prior to investing time in making a large PR. The "imperative mood" means written as if giving a command or instruction. See [[this excellent post|https://chris.beams.io/posts/git-commit/#imperative]] for more details, but the gist is that the title of the PR should make sense when used to complete the sentence "If applied, this commit will...". So for example, these are good PR titles:
* If applied, this commit will //update the contributing guidelines//
* If applied, this commit will //change css-escape-polyfill to a $tw.utils method//
* If applied, this commit will //make it easier to subclass the wikitext parser with a custom rule set//
These a poorly worded PR titles:
* ~~If applied, this commit will //edit text widgets should use default text for missing fields//~~
* ~~If applied, this commit will //signing the CLA//~~
* ~~If applied, this commit will //don't crash if options.event is missing//~~
PR titles may also include a short prefix to indicate the subsystem to which they apply. For example:
* //Menu plugin: Include menu text in aerial rotator//
! Contributor License Agreement ! Contributor License Agreement