From 20bbb46ba5e07f3678b977b3928780f83c0530e9 Mon Sep 17 00:00:00 2001 From: Mark Wales Date: Tue, 26 Mar 2019 20:37:03 +0000 Subject: [PATCH] docs: added contribution guidelines --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a5fdeec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +## Bug Reports/Feature Requests + +Please check the [roadmap.md](https://github.com/smallhadroncollider/cmt/blob/develop/roadmap.md) before adding any bugs/feature requests to Issues. + +## Code + +*Please use the `develop` branch as the base for any pull requests* + +Anyone is welcome to contribute to the project. Check out [roadmap.md](https://github.com/smallhadroncollider/cmt/blob/develop/roadmap.md) for bugs and planned features if you're not sure where to start. + +If you're planning on doing a big chunk of work it's probably best to [contact me](mailto:mark@smallhadroncollider.com) first to make sure someone isn't already working on it. + + +### Style + +Use `pure` instead of `return`, `*>` instead of `>>`, and `<>` instead of `++`. + +Please use [`hfmt`](https://github.com/danstiner/hfmt) to format files. + +### Git + +Please use the [git-flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model. You should only commit to `feature/*` branches: **do not commit to `develop` or `master` directly**. This will keep commit history simpler and make handling pull requests easier. + +Please also use the `--rebase` and `--ff-only` options when running `git pull` - although if you're on your own `feature/*` branch this shouldn't make any difference. + +### Testing + +Please add tests for any new functionality and make sure that all current tests pass.