Skip to content

Commit fa0cd74

Browse files
authored
Update CONTRIBUTING.md
1 parent 1481d3c commit fa0cd74

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

.github/CONTRIBUTING.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,26 @@ Please note that an [issue](https://github.com/aalhour/C-Sharp-Algorithms/issues
2121
- [Algorithm Request](https://github.com/aalhour/C-Sharp-Algorithms/issues)
2222
- [Data Structure Request](https://github.com/aalhour/C-Sharp-Algorithms/issues)
2323

24-
## Communication and Issues:
24+
## Communication and Issues
2525

26-
Whether you want to report a bug, an enhancement, a new data structure, or a new algorithm implementation please make sure you check out the issues first, someone might have started working on a similar idea already. If you are sure that what you want to contribute is new, then please open an issue describing what you want to accomplish before you decide to commit any code. This will guarantee no one else will work on the same file(s), data structure and/or algorithm you are working on.
26+
Please make sure you check out the issues first, someone might have started working on a similar idea already. If you are sure that what you want to contribute is new, then please open an issue describing what you want to implement before you decide to submit a PR.
2727

28-
It would be great if you can check out the existing [Issue Templates](ISSUE_TEMPLATE) which outline different types of contributions and how to submit them.
28+
Please refer to the [Issue Templates](ISSUE_TEMPLATE) to see the different types of contributions.
2929

30-
## Coding Conventions:
30+
## Submitting a Pull Requests
3131

32-
The coding conventions are the official Microsoft C# Coding Conventions. Most of the official code styling is supported by default on Visual Studio, but you need to set it up as a policy on Xamarian Studio via the Solution/Project properties window, in case you are using Xamarian Studio.
32+
After you commit your code, please submit your changes with a pull-request, you can do this on GitHub or through git. Please make sure to refer to the [Pull Request Guideline](PULL_REQUEST_TEMPLATE.md) when creating a new one.
33+
34+
## Coding Conventions
35+
36+
We follow the official Microsoft C# Coding Conventions (see: below). Most of the styleguide is supported by default on Visual Studio, but you need to set it up as a policy from the Solution/Project properties window, in case you are using Visual Studio Community.
37+
38+
Please refer to the following guidelines:
3339

34-
Please refer to the [Framework Design Guidelines](https://msdn.microsoft.com/en-us/library/ms229042(v=vs.110).aspx) document on MSDN.
40+
* [MS C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions)
41+
* [MS Framework Design Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/index?redirectedfrom=MSDN)
3542

36-
## NuGet and 3rd Party Libraries:
43+
## NuGet and 3rd Party Libraries
3744

3845
If your implementation depends on a 3rd party library, and you think it is critical, then please communicate this before you change the solution/projects references. We are striving to provide a bare-bones library of data structures and algorithms.
3946

@@ -45,7 +52,3 @@ You should write a test for every data structure and algorithm you implement. Th
4552

4653
* `AlgorithmsTests`: Package hosting unit tests for the Algorithms project.
4754
* `DataStructuresTests`: Package hosting unit tests for the Data Structures project.
48-
49-
## Submitting a Pull Request
50-
51-
After you commit your code, please submit your changes with a pull-request, you can do this on GitHub or through git. Please make sure to refer to the [Pull Request Guideline](PULL_REQUEST_TEMPLATE.md) when creating a new one.

0 commit comments

Comments
 (0)