This repository has been archived by the owner on Mar 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
79373fe
commit 20bbb46
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |