Bash-Snippets/CONTRIBUTING.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

2017-06-28 05:23:21 +02:00
# Contributing
2017-06-28 06:07:37 +02:00
### First off, thank you for considering contributing to Bash-Snippets.
2017-06-28 05:23:21 +02:00
2017-06-28 06:07:37 +02:00
#### Where do I go from here?
2017-06-28 05:23:21 +02:00
If you've noticed a bug or have a question, search the <a href="https://github.com/alexanderepstein/Bash-Snippets/issues">issue tracker</a> to see if someone else in the community has already created a ticket. If not, go ahead and <a href="https://github.com/alexanderepstein/Bash-Snippets/issues/new">make one</a>!
2017-06-28 06:07:37 +02:00
#### Otherwise if implementing a fix or feature go through these steps
#### 1. Fork & Clone The Repository
2017-06-28 05:23:21 +02:00
* Fork the repository
* It is assumed you are on either a Unix or Linux system in which are there are no dependencies
* To download the full source code after forking
```bash
git clone https://github.com/yourusernamehere/Bash-Snippets
```
2017-06-28 06:07:37 +02:00
#### 2. Implement your fix or feature
2017-06-28 05:23:21 +02:00
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat:
Make sure to make your commit messages informative and concise.
2017-06-28 06:07:37 +02:00
#### 3. Check The Script Runtime
2017-06-28 05:23:21 +02:00
If you changed the weather script for example try running it and see if it works as intended.
If you added a new script/tool test it to see if it works.
2017-06-28 06:07:37 +02:00
#### 4. Create A Pull Request
2017-06-28 05:23:21 +02:00
First make sure to commit and push your changes to your forked repository.
Check to see if there are any conflicts with the main repository and your fork.
If there are none submit the request and give details as to what you changed or added.
2017-06-28 06:07:37 +02:00
#### 5. Bask In All The Glory Of Adding To A FOSS Application
2017-06-28 05:23:21 +02:00
![Had to do it to em](https://68.media.tumblr.com/2dfc3369827df9b981e111d7fd8fc732/tumblr_mvemcyarmn1rslphyo1_400.gif)