Skip to content

Commit

Permalink
Merge pull request #60 from HimanshuMahto/contri
Browse files Browse the repository at this point in the history
Updated Contributing.md file
  • Loading branch information
Cyclenerd authored Oct 26, 2023
2 parents 551099a + b5b65b7 commit e1197ab
Showing 1 changed file with 54 additions and 18 deletions.
72 changes: 54 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,66 @@
# How to contribute
# How to Contribute

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

## Submitting changes
## Fork the Repository 🍴

Please send a [GitHub Pull Request](https://github.com/Cyclenerd/static_status/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)).
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.

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
## Clone Your Fork 📥

```
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
```
2. Clone your newly created fork of the repository to your local machine with the following command:

## Coding style
```bash
git clone https://github.com/your-username/static_status.git
```

Start reading the code and you'll get the hang of it. It is optimized for readability:
## Create a New Branch 🌿

* Variables must be uppercase and should begin with `MY_`.
* Functions must be lower case.
* Check your shell scripts with [ShellCheck](https://www.shellcheck.net/) before submitting.
* Please use tabs to indent.
3. Create a new branch for the specific issue or feature you are working on. Use a descriptive branch name:

```bash
git checkout -b "branch_name"
```

## Submitting Changes 🚀

4. Make your desired changes to the codebase.

5. Stage your changes using the following command:

```bash
git add .
```

6. Commit your changes with a clear and concise commit message:

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

## Push Your Changes 🚢

7. Push your local commits to your remote repository:

```bash
git push origin "branch_name"
```

## Create a Pull Request 🌟

8. 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! 👍
Keep it simple! 👍

Thanks! ❤️❤️❤️
Thanks! ❤️❤️❤️

0 comments on commit e1197ab

Please sign in to comment.