|
| 1 | +## Contribution Guidelines |
| 2 | + |
| 3 | +We love your input! We want you to make contributing to this simple questions/solutions repository as easy and transparent as possible, whether it's: |
| 4 | + |
| 5 | +- Reporting a bug |
| 6 | +- Discussing the current state of the code |
| 7 | +- Submitting a fix |
| 8 | +- Proposing new features |
| 9 | + |
| 10 | + |
| 11 | +## Contributing |
| 12 | + |
| 13 | + In general, we follow the "fork-and-pull" Git workflow. |
| 14 | + |
| 15 | + 1. **Fork** the repo on GitHub |
| 16 | + 2. **Clone** the project to your own machine |
| 17 | + 4. **Commit** changes to your own branch |
| 18 | + 5. **Push** your work back up to your fork |
| 19 | + 6. Submit a **Pull request** so that we can review your changes |
| 20 | + |
| 21 | +NOTE: Be sure to merge the latest from "upstream" before making a pull request! |
| 22 | + |
| 23 | + |
| 24 | +### Issues |
| 25 | + |
| 26 | +Feel free to submit issues and enhancement requests. |
| 27 | + |
| 28 | +Issues are very valuable to this project. |
| 29 | + |
| 30 | +* Ideas are a valuable source of contributions others can make |
| 31 | +* Problems show where this project is lacking |
| 32 | +* With a question you show where contributors can improve the user experience |
| 33 | + |
| 34 | + |
| 35 | +### Pull Requests |
| 36 | + |
| 37 | +Pull requests are, a great way to get your ideas into this repository. |
| 38 | + |
| 39 | +When deciding if I merge in a pull request I look at the following things: |
| 40 | + |
| 41 | + |
| 42 | +#### Does it state intent |
| 43 | + |
| 44 | +You should be clear which problem you're trying to solve with your contribution. |
| 45 | + |
| 46 | +For example: |
| 47 | + |
| 48 | +> Add a code for Arrays |
| 49 | +
|
| 50 | +Doesn't tell me anything about why you're doing that |
| 51 | + |
| 52 | +> Add a code for Arrays |
| 53 | +> > Question: Sum of numbers in an array(taking input for user) |
| 54 | +
|
| 55 | +Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it. |
| 56 | + |
| 57 | + |
| 58 | +#### Is it of good quality |
| 59 | + |
| 60 | +* There are no spelling mistakes |
| 61 | +* It reads well |
| 62 | + |
| 63 | + |
| 64 | +#### Does it move this repository closer to my vision for the repository |
| 65 | + |
| 66 | +The aim of this repository is: |
| 67 | + |
| 68 | +* To provide a simple implementaions of codes with time complexites on the go, anyone can copy and paste, into their project |
| 69 | +* The content is usable by someone who hasn't written something like this before |
| 70 | +* Foster a culture of respect and gratitude in the open source community. |
0 commit comments