Skip to content

Commit f2a0f2d

Browse files
committed
Update CONTRIBUTING.md
1 parent d6dceee commit f2a0f2d

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
1-
## Contributing
1+
# Contributing
22

3-
### Workflow
3+
Before submitting a feature or substantial code contribution please discuss it with the team in our [discussion group](https://groups.google.com/forum/?fromgroups#!forum/scriptcs).
44

5-
* We use the `dev` branch for active development.
6-
* `master` is only updated via pull requests from `dev`.
5+
## Workflow
6+
7+
* We use the **dev** branch for active development. All pull requests should be made to this branch.
8+
* The master branch is only updated via pull requests from the dev branch.
9+
* Tests need to be provided for every bug/feature that is completed.
10+
11+
## Issue Management
12+
13+
We use some tags to manage issue priority.
14+
15+
* **P1**: This is a big deal. It's either really awesome, terribly broken, or it's holding other awesome things up.
16+
* **P2**: This is kind of important and we're really looking forward to doing it, but there are more important things that need done first.
17+
* **P3**: We'd like to see these get implemented, but we're just not sure when we'll get to them. Want to take a shot at it? Go for it!
18+
19+
If the issue isn't marked with one of the above tags it's either still under discussion or not something we think we'll get to.
20+
21+
## Code Style
22+
23+
* Indent with spaces (4) instead of tabs.
24+
* Prefix private instance field names with an underscore and be camel-cased.
25+
* Use the `var` keyword unless the inferred type is not obvious.
26+
* Use the C# type aliases for types that have them (ex. `int` instead of `Int32`).
27+
* Use meaningful names (no hungarian notation).
28+
* Unit tests should follow the conventions detailed in [this blog post](http://haacked.com/archive/2012/01/02/structuring-unit-tests.aspx) by Phil Haack.
29+
* Unit tests assertions should be declared using the [Should Assertion Library](https://github.com/erichexter/Should) by Eric Hexter.

0 commit comments

Comments
 (0)