2
0
mirror of https://github.com/alexanderepstein/Bash-Snippets synced 2018-11-08 02:59:35 +01:00
Bash-Snippets/CONTRIBUTING.md
Alex Epstein 3c54484761 Fix this
2017-06-28 00:08:43 -04:00

1.6 KiB

Contributing

First off, thank you for considering contributing to Bash-Snippets.

Where do I go from here?

If you've noticed a bug or have a question, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one!

Otherwise if implementing a fix or feature go through these steps

1. 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
git clone https://github.com/yourusernamehere/Bash-Snippets

2. 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 😸 Make sure to make your commit messages informative and concise.

3. 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.

4. 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.

5. Bask In All The Glory Of Adding To A FOSS Application

Had to do it to em