mirrors/binario
1
0
Fork 0
mirror of https://github.com/Vimux/Binario.git synced 2024-11-13 02:18:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md

Browse source
This commit is contained in:
vimux 2021-06-14 10:11:54 -04:00
parent a56e1f5ed0
commit 3bb7a319f3
No known key found for this signature in database
GPG key ID: 5A34FDC4EE832E34
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -85,6 +85,13 @@ comments and it may take some time to complete.
* Keep PR up to date with upstream/master
* 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
* 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.
* 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
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.
* 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:
* Be less than 2048 bytes
* Be minified to a single line with no formatting