diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a4640e..2652439 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,31 @@ # Contributing -The project runs Git-flow, where the `master` branch is the development one and `production` is the production one. +We're always open to pull requests or code reviews. Everyone can become a permanent contributor. Just ping @lancedikson in the issues or on Twitter ❤️ -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. -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`. -Following these simple rules will help to maintain the repo a lot! Thanks ❤️ +## Branches + +The project runs Git-flow, where the `master` branch is for development and `production` is for production. + +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 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 really help maintain the repo! Thanks ❤️ + +## Adding Tests + +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 +check if all tests are still passing. + +## Testing + +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 +$ npm install +$ npm run build #build +$ npm test #run tests +$ npm run lint #check lint rules +``` diff --git a/README.md b/README.md index b940e6b..1adf103 100644 --- a/README.md +++ b/README.md @@ -130,25 +130,6 @@ Thus, you can define OS or platform specific rules and they will have more prior More of API and possibilities you will find in the `docs` folder. -# Contributing - -We're always open to pull requests or code reviews. Everyone can become a permanent contributor. Just ping @lancedikson in the issues or on Twitter ❤️ - -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): - -``` sh -$ npm install -$ npm run build #build -$ npm test #run tests -$ npm run lint #check lint rules -``` - -### Adding tests -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 -check if all tests are still passing. - ### Similar Projects * [Kong](https://github.com/BigBadBleuCheese/Kong) - A C# port of Bowser.