Skip to content

Commit 9a97895

Browse files
author
n.bitounis
committed
Merge branch 'master' of https://github.com/nickntg/C-Sharp-Algorithms into nuget
2 parents 44cfba6 + b9e31af commit 9a97895

37 files changed

+2249
-732
lines changed
File renamed without changes.

.github/CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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+
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.
27+
28+
Please refer to the [Issue Templates](ISSUE_TEMPLATE) to see the different types of contributions.
29+
30+
## Submitting a Pull Requests
31+
32+
Pull requests should be submitted from your cloned repository's `master` branch to the upstream `master` branch. Please make sure that you rebase your local branch against the upstream branch before you submit your pull request.
33+
34+
Please make sure to refer to the [Pull Request Guideline](PULL_REQUEST_TEMPLATE.md) when submitting a new one.
35+
36+
## Coding Conventions
37+
38+
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.
39+
40+
Please refer to the following guidelines:
41+
42+
* [MS C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions)
43+
* [MS Framework Design Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/index?redirectedfrom=MSDN)
44+
45+
## NuGet and 3rd Party Libraries
46+
47+
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.
48+
49+
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.
50+
51+
## Source Code Testing
52+
53+
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:
54+
55+
* `AlgorithmsTests`: Package hosting unit tests for the Algorithms project.
56+
* `DataStructuresTests`: Package hosting unit tests for the Data Structures project.

.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+

.github/workflows/build_and_test.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Build and Test
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v1
10+
- name: Setup .NET Core
11+
uses: actions/setup-dotnet@v1
12+
with:
13+
dotnet-version: 2.2.108
14+
- name: Build with .NET Core
15+
run: dotnet build --configuration Release
16+
test:
17+
runs-on: ubuntu-latest
18+
needs: build
19+
steps:
20+
- uses: actions/checkout@v1
21+
- name: Run Tests
22+
run: dotnet test

.github/workflows/greetings.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Greetings
2+
3+
on: [pull_request, issues]
4+
5+
jobs:
6+
greeting:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/first-interaction@v1
10+
with:
11+
repo-token: ${{ secrets.GITHUB_TOKEN }}
12+
issue-message: 'Thanks for supporting the development of C# Algorithms with your first issue! We look forward to handling it.'
13+
pr-message: 'Congratulations! You are officially a C# Algorithms contributor! :tada:'

.gitignore

Lines changed: 2 additions & 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*/
@@ -193,3 +194,4 @@ ModelManifest.xml
193194

194195
# Local test runner
195196
testrunner
197+

.travis.yml.new

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

0 commit comments

Comments
 (0)