Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 1.63 KB

How to Contribute

First off, thanks for taking the time to contribute!👏

Fork the Repository 🍴

  1. Start by forking the repository. You can do this by clicking the "Fork" button in the upper right corner of the repository page. This will create a copy of the repository in your GitHub account.

Clone Your Fork 📥

  1. Clone your newly created fork of the repository to your local machine with the following command:

    git clone https://github.com/your-username/static_status.git

Create a New Branch 🌿

  1. Create a new branch for the specific issue or feature you are working on. Use a descriptive branch name:

    git checkout -b "branch_name"

Submitting Changes 🚀

  1. Make your desired changes to the codebase.

  2. Stage your changes using the following command:

    git add .
  3. Commit your changes with a clear and concise commit message:

    git commit -m "A brief summary of the commit."

Push Your Changes 🚢

  1. Push your local commits to your remote repository:

    git push origin "branch_name"

Create a Pull Request 🌟

  1. Go to your forked repository on GitHub and click on the "New Pull Request" button. This will open a new pull request to the original repository.

Coding Style 📝

Start reading the code, and you'll get the hang of it. It is optimized for readability:

  • Variables must be uppercase and should begin with MY_.
  • Functions must be lowercase.
  • Check your shell scripts with ShellCheck before submitting.
  • Please use tabs to indent.

One more thing:

Keep it simple! 👍

Thanks! ❤️❤️❤️