Archives/lancedikson_bowser
1
0
Fork 0
mirror of https://github.com/lancedikson/bowser synced 2024-10-27 20:34:22 +00:00
Code Issues Releases Wiki Activity

Improve CONTRIBUTING.md

Browse Source
This commit is contained in:
JBallin 2019-01-21 11:28:11 -08:00
parent e87ce75599
commit 86f8f63e50
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -4,24 +4,24 @@ We're always open to pull requests or code reviews. Everyone can become a perman
## Branches ## Branches
The project runs Git-flow, where the `master` branch is the development one and `production` is the production one. The project runs Git-flow, where the `master` branch is for development and `production` is for production.
In a nutshell, if you're about to propose a new feature with adding some totally new functionality to `bowser`, it's better to branch from `master` and make a PR pointing back to `master` as well. In a nutshell, if you are proposing a new feature that adds totally new functionality to `bowser`, it's better to branch from `master` and make a PR pointing back to `master` as well.
If it's a small hotfix, fix a typo in the docs or you've added support for a new browser/OS/platform/etc, then it's better to branch from `production` and make a PR pointing back to `production`. If it's a small hot-fix, an improvement to the docs, or added support for a new browser/OS/platform/etc, then it's better to branch from `production` and make a PR pointing back to `production`.
Following these simple rules will help to maintain the repo a lot! Thanks ❤️ Following these simple rules will really help maintain the repo! Thanks ❤️
## Adding Tests ## Adding Tests
See the list in `test/acceptance/useragentstrings.yml` with example user agents and their expected bowser object. See the list in `test/acceptance/useragentstrings.yml` with example user agents and their expected `bowser` object.
Whenever you add support for new browsers or notice a bug / mismatch, please update the list and Whenever you add support for new browsers or notice a bug / mismatch, please update the list and
check if all tests are still passing. check if all tests are still passing.
## Testing ## Testing
If you'd like to contribute a change to bowser, modify the files in `src/`, then run the following (you'll need node + npm installed): If you'd like to contribute a change to `bowser`, modify the files in `src/`, and run the following (you'll need `node` + `npm` installed):
``` sh ``` sh
$ npm install $ npm install