mirrors/binario
1
0
Fork 0
mirror of https://github.com/Vimux/Binario.git synced 2024-12-04 03:48:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md

Browse source
This commit is contained in:
vimux 2021-06-25 15:16:46 -04:00
parent c971411a64
commit 2479b02425
No known key found for this signature in database
GPG key ID: 5A34FDC4EE832E34
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -86,12 +86,12 @@ comments and it may take some time to complete.
* Pay attention to any automated CI failures reported in the Pull Request * Pay attention to any automated CI failures reported in the Pull Request
* PR solves a common use case that several users will need in their real-life projects, not only your specific problems * PR solves a common use case that several users will need in their real-life projects, not only your specific problems
* Before you start something new or refactor something old, make sure you've read through the codebase and understand * Before you start something new or refactor something old, make sure you've read through the codebase and understand
each part's purpose so that you don't break something. each part's purpose so that you don't break something
* Always try to avoid breaking changes. But if they are needed, then mark each breaking commit with a * Always try to avoid breaking changes. But if they are needed, then mark each breaking commit with a
"BREAKING CHANGE:" prefix in the commit title and a detailed explanation in the commit description of what happened and "BREAKING CHANGE:" prefix in the commit title and a detailed explanation in the commit description of what happened and
what the user needs to do. what the user needs to do
* A deprecated param will be maintained for a 6 month transition period, after which it will be removed at any time. * Deprecated params must be maintained for a 6-month transition period
* If something mandates an unclear solution, leave a comment behind for the contributors that come after you. * If something mandates an unclear solution, leave a comment behind for the contributors that come after you
* If you've added or modify SVG, ensure that each SVG file: * If you've added or modify SVG, ensure that each SVG file:
* Be less than 2048 bytes * Be less than 2048 bytes
* Be minified to a single line with no formatting * Be minified to a single line with no formatting