CONTRIBUTING.md 2.8 KB
Newer Older
B
Boris Djurdjevic 已提交
1 2
## Contributing

B
Boris Djurdjevic 已提交
3
👍 First off, thanks for taking the time to contribute! 👍<br>
B
Boris Djurdjevic 已提交
4 5
Working together we can make a better tool for everyone.

B
Boris Djurdjevic 已提交
6 7 8 9 10 11
## Code of Conduct

This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.
By making a PullRequest Contributor assigns the copyright to the project owner.

B
Boris Djurdjevic 已提交
12 13
### Where do I go from here?

B
Boris Djurdjevic 已提交
14
If you've noticed a bug or have an idea about new feature you can open a issue.
B
Boris Djurdjevic 已提交
15
Before doing that please go through README and existing issues(both open and closed) and check if that question already exist to avoid duplication.
B
Boris Djurdjevic 已提交
16
Once the issue is created we will discuss it there and decide the next actions.
B
Boris Djurdjevic 已提交
17 18

If that would be something you think you can fix, please suggest your solution and we can coordinated accordingly.
B
Boris Djurdjevic 已提交
19
When making changes on code please go through all code for understanding whole picture in order to make change affect everything it should but no more, and to do it in the correct way.
B
Boris Djurdjevic 已提交
20

B
Boris Djurdjevic 已提交
21
After that Tests should up updated if change affects them, or new Tests could be created.
B
Boris Djurdjevic 已提交
22
Lastly README should be updated if additional explanations are required regarding the change.
B
Boris Djurdjevic 已提交
23 24 25 26 27 28 29 30 31 32

### How Do I Submit A (Good) Bug Report?
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps. 
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.

## Submitting changes

B
Boris Djurdjevic 已提交
33
Please send a GitHub Pull Request with a clear list of what you've done (read more about [pull requests](https://help.github.com/articles/about-pull-requests/)). Please follow coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
B
Boris Djurdjevic 已提交
34 35 36 37 38 39 40 41 42

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

    $ git commit -m "A brief summary of the commit
    > 
    > A paragraph describing what changed and its impact."

## Coding conventions

B
borisdj 已提交
43
Start reading the code and you'll get the hang of it. It is optimized for readability:
B
Boris Djurdjevic 已提交
44 45

  * This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
B
Boris Djurdjevic 已提交
46 47 48
  * https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/index
  * https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions
  * https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/index