diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a72e7552 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing + +Thanks for being willing to contribute! + +**Working on your first Pull Request?** You can learn how from this _free_ +series [How to Contribute to an Open Source Project on GitHub][egghead] + +## Project setup + +1. Fork and clone the repo +2. Run `npm ci` to install dependencies +3. Create a branch for your PR with `git checkout -b feature/your-branch-name` + +> Tip: Keep your `master` branch pointing at the original repository and make +> pull requests from branches on your fork. To do this, run: +> +> ``` +> git remote add upstream git@github.com:smeijer/testing-playground.git +> git fetch upstream +> git branch --set-upstream-to=upstream/master master +> ``` +> +> This will add the original repository as a "remote" called "upstream," Then +> fetch the git information from that remote, then set your local `master` +> branch to use the upstream master branch whenever you run `git pull`. Then you +> can make all of your pull request branches based on this `master` branch. +> Whenever you want to update your version of `master`, do a regular `git pull`. + +## Committing and Pushing changes + +Please make sure to run the tests before you commit your changes. You can run +`npm run test` to do so. + +### Linting with git hooks + +There are git hooks set up with this project that are automatically installed +when you install dependencies. They're really handy, and will take care of linting +and formatting for you. + +## Help needed + +Please checkout the [the open issues][issues] + +Also, please watch the repo and respond to questions/bug reports/feature +requests! Thanks! + +[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github +[issues]: https://github.com/smeijer/testing-playground/issues diff --git a/README.md b/README.md index 3e4cbbe6..bd8f8fd9 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,21 @@ Testing-Playground provides you with direct feedback. Trying to visualize the di ## Roadmap -Future ideas are maintained in the [roadmap]. Please use the [issue tracker] to discuss any questions or suggestions you have. +Future ideas are maintained in [roadmap.md]. Please use the [issue tracker] to discuss any questions or suggestions you have. Every section in the roadmap is accompanied by one or more issues. Contributions are most welcome! +## Contributing + +Please see [contributing.md] for more details. If you just want to run the playground on your own machine, go to your terminal and enter the following commands: + +```bash +git clone git@github.com:smeijer/testing-playground.git +cd testing-playground +npm ci +npm run start +``` + ## Contributors Thanks goes to these people ([emoji key][emojis]): @@ -46,7 +57,8 @@ Thanks goes to these people ([emoji key][emojis]): This project follows the [all-contributors][all-contributors] specification. Contributions of any kind welcome! -[roadmap]: https://github.com/smeijer/testing-playground/blob/master/ROADMAP.md +[roadmap.md]: https://github.com/smeijer/testing-playground/blob/master/ROADMAP.md +[contributing.md]: https://github.com/smeijer/testing-playground/blob/master/ONTRIBUTING.md [issue tracker]: https://github.com/smeijer/testing-playground/issues [all-contributors]: https://github.com/all-contributors/all-contributors [emojis]: https://github.com/all-contributors/all-contributors#emoji-key