Skip to content

Latest commit

 

History

History
108 lines (74 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

108 lines (74 loc) · 4.16 KB
Raw

Contributing to TeachMeBashLikeIm5

All inputs are welcome!

This repo is part of the inspirezone.tech portfolio of projects located on our Github page

Inspirezone is an online tech blog and community that focuses on encouraging developers of all levels of experience to improve their skills through online collaboration.

Consider joining the inspirezone community here! You don't have to join to contribute to this project. However, joining will give you a number of advantages such as:

  • You can join our Github community page
  • Have discussions with other members of our community
  • Be part of an accountability group that will encourage you to code more
  • Potentially become a project maintainer
  • Get notified of other projects and activities within our community
  • It's fun to improve your skills by working with others!

Please make sure you are assigned to an Issue before submitting a pull request

Go to the issue page and either

  • Request to be assigned to an existing issue
  • Create your own issue and use one of the templates provided. Wait for approval and to be assigned the issue before submitting a pull request

Note: You can only be assigned to one issue at a time. Please clear your assigned issue before requesting to be assigned to another.

Contributions you can make to this project

  • Add a tutorial
  • Improve an existing tutorial
  • Report a bug or problem with the repo or a tutorial
  • Suggest a tutorial
  • Help with documentation
  • Make any suggestion for improvement

Guidelines for submitting a tutorial

  • Tutorial should explain a BASIC concept of bash
  • Each tutorial should be a ".sh" file and should be executable
  • Each tutorial should come with a challenge that can be verified through a print of the expected result/results to console
  • All folders and files should be named using lower cases with words separated by '-' e.g. for-loops.sh
  • Please use the following template for each tutorial:
# ------------------------------------------------------------------------------------
# Tutorial: brief description of tutorial content
# ------------------------------------------------------------------------------------

# Code here explaining concept with comments to guide

# ------------------------------------------------------------------------------------
# Challenge: list challenges to be completed here. minimum of one challenge per tutorial
# ------------------------------------------------------------------------------------

Feel free to be as creative as you want when coming up with challenges!

Use shellcheck linting to ensure format of code is consistent with repo

How to run shellcheck using command line:

sudo apt-get install shellcheck

shellcheck path/to/code/to/check.sh

How to submit your code - step by step guide

Please use pull requests. See the Github docs for details on how pull requests work.

Steps to make your contribution:

1. Fork this repo

2. Clone it locally

3. Add this repo as the remote upstream and keep it synced by pulling from upstream

git remote add upstream https://github.com/inspirezonetech/TeachMeBashLikeIm5.git

git pull upstream main

4. Create a new branch and checkout to the branch

 git checkout -b your-branch

5. Make your changes and test it works

6. Commit your changes

git commit -m "commit message describing change"

7. Push to your Fork

git push origin your-branch

8. Go to your Fork on Github and create a pull request to this repo on Github. Fill in the PR submission form.

9. If needed, respond to code review comments and feedback

10. If all goes well, your changes will be merged. Congrats!

License

By contributing, you agree that your contributions will be licensed under its MIT License.