Skip to content

Commit 958621e

Browse files
authored
Move Community Templates under .github directory (#115)
* Moved all project templates under .github directory. * Update CONTRIBUTING.md * Updated the BUG_REPORT template * Renamed Bug Report template * Renamed the feature request template * Renamed the feature request template.
1 parent 16b0512 commit 958621e

File tree

10 files changed

+73
-46
lines changed

10 files changed

+73
-46
lines changed
File renamed without changes.

.github/CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contribution Guidelines
2+
3+
Hi there, and thanks for your interest in the C# ALGORITHMS repository. This document serves as a set of general guidelines for open-source contribution.
4+
5+
Please follow the [Contributor Code of Conduct](CODE_OF_CONDUCT.md) for all your interactions.
6+
7+
## Types of Contributions
8+
9+
Please note that an [issue](https://github.com/aalhour/C-Sharp-Algorithms/issues) is **required** for all project contributions. The following is a list of the different types of contributions:
10+
11+
- _To help keep the project running smoothly_
12+
- [Report Bugs](https://github.com/aalhour/C-Sharp-Algorithms/issues)
13+
- [Fix Bugs](https://github.com/aalhour/C-Sharp-Algorithms/issues)
14+
15+
- _To help improve existing functionality_
16+
- [Change Request](https://github.com/aalhour/C-Sharp-Algorithms/issues)
17+
- [Implement Changes](https://github.com/aalhour/C-Sharp-Algorithms/issues)
18+
19+
- _To help increase the projects functionality_
20+
- [Feature Request](https://github.com/aalhour/C-Sharp-Algorithms/issues)
21+
- [Algorithm Request](https://github.com/aalhour/C-Sharp-Algorithms/issues)
22+
- [Data Structure Request](https://github.com/aalhour/C-Sharp-Algorithms/issues)
23+
24+
## Communication and Issues:
25+
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.
27+
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.
29+
30+
## Coding Conventions:
31+
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.
33+
34+
Please refer to the [Framework Design Guidelines](https://msdn.microsoft.com/en-us/library/ms229042(v=vs.110).aspx) document on MSDN.
35+
36+
## NuGet and 3rd Party Libraries:
37+
38+
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.
39+
40+
In all cases, you should not commit the installed 3rd party libraries into the project. The README document will provide all the steps anyone would need to compile the library on their machine.
41+
42+
## Source Code Testing
43+
44+
You should write a test for every data structure and algorithm you implement. The test should be created under the `UnitTest` project and in the corresponding packages:
45+
46+
* `AlgorithmsTests`: Package hosting unit tests for the Algorithms project.
47+
* `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.

.github/ISSUE_TEMPLATE/bug_report.md renamed to .github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,13 @@ Steps to reproduce the behavior:
2020
**Expected behavior**
2121
A clear and concise description of what you expected to happen.
2222

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25-
26-
**Desktop (please complete the following information):**
23+
**Environmnet:**
2724
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
25+
- .NET Version: [e.g. .NET Core v2.1]
26+
- IDE: [e.g. Visual Studio Code]
3027

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
28+
**Screenshots**
29+
If applicable, add screenshots to help explain your problem.
3630

3731
**Additional context**
3832
Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### Description
2+
3+
<!-- Please include a summary of the change and which issue is fixed (i.e. `closes #XXXX`). -->
4+
5+
### Checklist
6+
7+
- [ ] An issue was first created **before** opening this pull request
8+
- [ ] The new code follows the [contribution guidelines](CONTRIBUTING.md)
9+
- [ ] I have performed a self-review of my own code
10+
- [ ] I have commented my code, particularly in hard-to-understand areas
11+
- [ ] I have made corresponding changes to the documentation
12+
- [ ] My changes generate no new warnings
13+
- [ ] I have added tests to ensure that prove my fix is effective or that my feature works
14+
- [ ] New and existing unit tests pass locally with my changes
15+

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ bld/
1919

2020
# Roslyn cache directories
2121
*.ide/
22+
.ionide/
2223

2324
# MSTest test Results
2425
[Tt]est[Rr]esult*/

CONTRIBUTING.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ This is a C#.NET solution-project, and it contains three subprojects:
5858

5959
#### A Note to Contributors:
6060

61-
If you wish to contribute to C# ALGORITHMS, then please make sure you check out the [Contribution Guidelines](CONTRIBUTING.md) first.
62-
63-
Note: The projects where tested with Visual Studio Community using .NET Core 2.0.3 on mac OS.
61+
If you wish to contribute to C# ALGORITHMS, then please make sure you check out the [Contribution Guidelines](.github/CONTRIBUTING.md) first.
6462

6563
##
6664
### DATA STRUCTURES

0 commit comments

Comments
 (0)