Skip to content

Commit ed01f29

Browse files
add new maintainers and contrib doc
1 parent 766ba61 commit ed01f29

File tree

2 files changed

+48
-2
lines changed

2 files changed

+48
-2
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
Your help is greatly appreciated! This project, as all other open-source projects, thrives through an active community. But: With great power comes great responsibility. So we have devised a few ground rules that should be followed when contributing.
4+
5+
## How can you contribute?
6+
7+
There are a couple of ways you can help us out.
8+
9+
* [Issues](#Issues): The easiest way to contribute is to identify that something is broken or that a feature is missing and create an issue from it. Even better would be fixing an open issue that has no assignee yet. You can of course do both - find something that is missing and fix it yourself!
10+
* [Reviews](#Reviews): With more contributions coming in we will likely see more pull requests. Reviewing them is not always the most fun, but it is very necessary and would help a lot.
11+
12+
## Issues
13+
14+
### Standard issues
15+
16+
Opening issues is very easy. Head to our [Issues tab](https://github.com/PowerShell/EditorSyntax/issues) and open one if it does not exist already. If an issue exists that might have something to do with yours, e.g. is the basis for something your are requesting, please link this issue to yours.
17+
18+
### Highlighting bugs
19+
20+
If you encounter an error during usage of EditorSyntax, there are some basic details we need to be able to help you.
21+
22+
1. The script you used. Feel free to strip out any incriminating details, but it must be able to be executed
23+
2. A screenshot of the highlighting bug
24+
25+
### Fixing an issue
26+
27+
Fixing issues also does not require a lot of administrative work. The basic steps are:
28+
29+
1. Leave a comment to tell us that you are working on it
30+
2. Fork our repository, and base your changes off of the **master** branch. Please create a new branch from **master** which contains your changes. How you call it? We don't care.
31+
3. Fix the issue! No biggie...
32+
4. Make sure you have pushed your commits to your new branch and then create a pull request back to the EditorSyntax **master** branch
33+
5. If prompted to sign the CLA, please follow the action
34+
35+
## Reviews
36+
37+
We are using GitHub's internal capabilities for our code reviews. Either we, the EditorSyntax team, or you, the community, can review the changes and add comments. The author of the pull request can then go through all issues, fix them and add commits to his branch, which will show up in the pull request. When all issues are fixed and there is nothing else to do, we will gladly merge your pull request.

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,20 @@ send pull requests if you'd like to contribute.
6262
6363
## Maintainers
6464
65-
- [Sergei Vorobev](https://github.com/vors) - [@xvorsx](https://twitter.com/xvorsx)
66-
- [Øyvind Kallstad](https://github.com/gravejester) - [@okallstad](https://twitter.com/okallstad)
65+
- [Nick James](https://github.com/omniomi) - [@omniomi](https://twitter.com/omniomi)
66+
- [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](https://twitter.com/TylerLeonhardt)
6767
6868
## License
6969
7070
This extension is [licensed under the MIT License](LICENSE). Please see the
7171
[third-party notices](Third%20Party%20Notices.txt) file for details on the original
7272
source of the TextMate definition that we use.
73+
74+
## Code of Conduct
75+
76+
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
77+
For more information see the [Code of Conduct FAQ][conduct-faq] or contact [[email protected]][conduct-email] with any additional questions or comments.
78+
79+
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
80+
[conduct-faq]: http://opensource.microsoft.com/codeofconduct/faq/
81+
[conduct-email]: mailto:[email protected]

0 commit comments

Comments
 (0)