ilyakooo0/urbit
1
0
Fork 0
mirror of https://github.com/ilyakooo0/urbit.git synced 2024-08-15 21:50:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

contributing: improve description.. description

Browse Source 
This factors the finer details out of the broad description spec, moving
them into the next paragraph.
This commit is contained in:
Jared Tobin 2019-08-28 13:21:22 -02:30
parent 9ce01da050
commit 4dbb224abb
No known key found for this signature in database
GPG Key ID: 0E4647D58F8A69E4
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -54,16 +54,17 @@ others.
Commits should generally be relevant, atomic, and have descriptions formatted
in the following manner:
> component: short description (<= 50 characters total)
> component: short description
>
> long description (optional)
> long description
The 'component' is a short prefix of what area of the codebase the commit
applies to. If a commit patches `%gall`, for example, the description should
be prefixed by 'gall'. If it touches `:aqua`, it should be prefixed by 'aqua'.
If it touches multiple components, then separate these by commas, e.g. "gall,
aqua, ph" -- but note that this may be a warning that too many changes are
being packed into a single commit.
being packed into a single commit. The 'component' and 'short description'
combined should be no more than 50 characters.
A lengthier description is encouraged, where useful, but is not required.