Skip to content

Commit 3f96b6d

Browse files
author
Karan Goel
committed
Better way of contributing solutions
1 parent ad8e102 commit 3f96b6d

File tree

2 files changed

+256
-263
lines changed

2 files changed

+256
-263
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,26 @@
1-
How to Contribute
2-
==================
3-
4-
## Solutions
5-
6-
Please **do not send pull requests for replacing my code**. If you'd like to contribute solutions, please see the following instructions:
7-
8-
- Solve the problem, and keep it in your repo. DO NOT send merge request yet.
9-
10-
- Find the problem in this [README](https://github.com/thekarangoel/Projects/blob/master/README.md) file.
11-
12-
- Edit the file in this format (notice the double square brackets):
13-
14-
\**This is a problem** - And here goes it's description. \[[octocat]]\(link-to-octocats-solution) \[[your_username]]\(link-to-your-solution)
15-
16-
This results in something like this:
17-
18-
**This is a problem** - And here goes it's description. [[octocat]](link-to-octocats-solution) [[your_username]](link-to-your-solution)
19-
20-
- Please respect other people and do not delete or move anyone else's link. Place your solution at the end of the list of solutions.
21-
22-
- Save/Commit the README.md file.
23-
- Send a pull request for this commit ONLY!
24-
25-
=====================================
26-
27-
## Projects
28-
29-
If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/thekarangoel/Projects/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes. If you add a problem, make sure you add it in the correct category.
30-
31-
It is required that any changes made to the projects (this does not include adding solutions) in *README.md*, must be reflected in *README-scratch.md* and in *README.md* file in the relevant category folder. If you're copying a project from some other webpage, you **MUST** link to it in the *Sources* section at the bottom of repo's *README.md* and *README-scratch.md*.
32-
33-
If you skip any step(s), I will not merge the changes!
1+
How to Contribute
2+
==================
3+
4+
## Solutions
5+
6+
Please **do not send pull requests for replacing my code**. If you'd like to contribute solutions, please see the following instructions:
7+
8+
- Solve the problem, and keep it in your repo. DO NOT send merge request yet.
9+
10+
- [Open an issue](https://github.com/thekarangoel/Projects/issues/new) with the following details - problem you solved, language used, and a link to the solution.
11+
12+
- The link to your solution will be present in this [gist](https://gist.github.com/thekarangoel/6088143) like so:
13+
14+
**This is a problem** - And here goes it's description. [[octocat (Python)]](link-to-octocats-solution) [[your_username(C++)]](link-to-your-solution)
15+
16+
- That's it. As soon as I get online I'll add the link to the gist! You do not need to do anything else.
17+
18+
=====================================
19+
20+
## Projects
21+
22+
If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/thekarangoel/Projects/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes. If you add a problem, make sure you add it in the correct category.
23+
24+
It is required that any changes made to the projects (this does not include adding solutions) in *README.md*, must be reflected in *README-scratch.md* and in *README.md* file in the relevant category folder. If you're copying a project from some other webpage, you **MUST** link to it in the *Sources* section at the bottom of repo's *README.md* and *README-scratch.md*.
25+
26+
If you skip any step(s), I will not merge the changes!

0 commit comments

Comments
 (0)