Skip to content

Commit 9c157af

Browse files
committed
edit CONTRIBUTING.md
1 parent f0b422c commit 9c157af

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,31 @@
1-
Contributing
2-
============
1+
## Contributing
32

4-
There are two permanent brances: **master** and **dev**.
5-
**Master** always points to the latest release tag.
6-
All development is done in **dev** branch,
7-
please, use it for pull requests.
83

9-
If you are fixing grammar (syntax highlighting), please, add affected samples to [test-file.ps1](/tests/samples/test-file.ps1).
10-
We use it in automated tests that compare grammar against PowerShell tokenizer.
11-
It also serves as a place for humans to stare to all exotic language constructions.
4+
Thanks for taking an insterest in contributing to the PowerShell package for
5+
Sublime Text 3!
6+
7+
8+
### Development
9+
10+
Development happens on the **dev** branch. Please send your PRs against that
11+
branch only.
12+
13+
14+
#### Running Tests
15+
16+
If you ara adding functionality or making substantial changes to existing
17+
code, please add tests and ensure that existing tests pass.
18+
19+
Currently, we have very few tests and they aren't easy to run... :-(
20+
21+
If you feel lazy about writing tests, this is the right time to contribute --
22+
we'll turn a blind eye more often now than later on! ;-)
23+
24+
25+
### Building Versions
26+
27+
The easiest way to 'build' a version now consists in copying the top-folder's
28+
content to your *Data/Packages/PowerShell* directory.
29+
30+
We have build scripts under *.\bin*, but they aren't realiable. We hope to fix
31+
this soon.

0 commit comments

Comments
 (0)