37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
### First off, thank you for considering contributing to Sandman.
|
||
|
|
|
||
|
|
#### 1. Where do I go from here?
|
||
|
|
|
||
|
|
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>!
|
||
|
|
|
||
|
|
|
||
|
|
#### 2. Fork & Clone The Repository
|
||
|
|
* 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
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
#### 3. Implement your fix or feature
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
#### 4. Check The Script Runtime
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
#### 6. Create A Pull Request
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
#### 7. Bask In All The Glory Of Adding To A FOSS Application
|
||
|
|
|