|
1 | 1 | # Contributing Guidelines |
2 | 2 |
|
3 | | -__TODO__ |
| 3 | +Contributions are always welcome! |
| 4 | + |
| 5 | +If you're interested in contributing but you're not sure what to work on, take a look at our [open issues](https://github.com/ripjar/material-datetime-picker/issues). If you have an idea already, we accept [Pull Requests](https://help.github.com/articles/about-pull-requests/). If it's a big change, please open an issue first so we can talk it through. |
| 6 | + |
| 7 | +## Getting started |
| 8 | + |
| 9 | +If you're new to open source, welcome! We would love to help you get started. Here's a quick guide: |
| 10 | + |
| 11 | +* Decide what to work on, or find an [issue](https://github.com/ripjar/material-datetime-picker/issues) that you're interested in. |
| 12 | +* Fork this project. That creates your own copy of the code so can make changes without affecting the main project. |
| 13 | +* Clone your fork! That gets the code onto your local computer. You can do that on the command line: |
| 14 | + |
| 15 | +``` |
| 16 | +git clone https://github.com/YOUR_USERNAME/material-datetime-picker.git |
| 17 | +``` |
| 18 | + |
| 19 | +* Create a branch to work on. This is a kind of seperate working area for this particular contribution: |
| 20 | + |
| 21 | +``` |
| 22 | +git checkout -b your-branch-name |
| 23 | +``` |
| 24 | + |
| 25 | +* Write your code, documentation or whatever you are contributing! |
| 26 | +* Commit your code to your local repository: |
| 27 | + |
| 28 | +``` |
| 29 | +git commit -a -m "Write a short summary of your changes here!" |
| 30 | +``` |
| 31 | + |
| 32 | +* Push your commited changes to your fork: |
| 33 | + |
| 34 | +``` |
| 35 | +git push origin your-branch-name |
| 36 | +``` |
| 37 | + |
| 38 | +* Open a Pull Request on the [main repo](https://github.com/ripjar/material-datetime-picker). That's when we get to see your code. Add a descriptive title and a summary of the changes you've made. |
| 39 | + |
| 40 | +* We'll review your code and go through any changes that we'd like you to make. Please don't worry about this - it's a totally normal part of most software projects, and it's common for changes to be requested. This isn't a slight on you or your code - it's a way of keeping the project's quality high, and hopefully for you to learn something! |
| 41 | + |
| 42 | +* Make any fixes that we've asked for, and repeat steps 6 - 9. This might happen a few times. |
| 43 | + |
| 44 | +* When we're both happy with your pull request, we'll merge it. Congratulations! |
| 45 | + |
| 46 | + |
| 47 | +## In short |
| 48 | +If you've done this kind of thing before: |
| 49 | + |
| 50 | +* Please be kind and respectful at all times. Treat your fellow contributors with empathy. If your contribution is excellent but your attitude isn't, we're not interested. |
| 51 | +* Please make pull requests from a feature branch |
| 52 | +* Lint with `eslint`. You can `npm run lint`. |
| 53 | +* Follow the existing project style (we use https://github.com/airbnb/javascript) |
| 54 | +* Use [BEM](http://getbem.com/introduction/) for CSS |
| 55 | +* You don't need to `npm run build`. We'll do that before cutting a release. |
| 56 | + |
| 57 | +## Where can I get help? |
| 58 | + |
| 59 | +Right now the best way to get help is to [open an issue](https://github.com/ripjar/material-datetime-picker/issues), or ask me on Twitter [@jwhitfieldseed](https://twitter.com/jwhitfieldseeds |
| 60 | +). |
0 commit comments