mirror/pcottle.learnGitBranching
1
0
Fork 0
mirror of https://github.com/pcottle/learnGitBranching.git synced 2025-06-20 21:35:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Create CONTRIBUTING

Browse source 
first take on this
This commit is contained in:
Peter Cottle 2022-08-20 08:09:53 -06:00 • committed by GitHub
parent 88a6d34e91
commit 019c949d39
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING Normal file
View file

@ -0,0 +1,15 @@
## Welcome to the Learn Git Branching contributing guide!
We have a pretty relaxed environment in this project so there's no formal template to submit Pull Requests for. Contributions generally fall into two buckets:
### Translations
I welcome all translation improvements or additions! The levels are stored in giant JSON blobs, keyed by locale for each string. This means its somewhat awkward to add new translations, since you have to edit the JSON manually.
### Bug Fixes, New Features, etc
These are great too! If you are adding new functionality to the git engine, I would try to add some tests in the `__tests__` folder. It's pretty simple, you can just input a bunch of git commands and show the expected tree state afterwards.
For bug fixes or CSS/style layout issues, simply attach screenshots of the before and after. For more obscure browsers, targeted CSS rules by browser is a bit more preferred.
Thanks for stopping by!