Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Added Contributing.md to repo.
  • Loading branch information
Kalyanimhala committed Oct 31, 2023
1 parent 0c4045d commit 24fb60f
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# 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 πŸ“₯

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

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

## Create a New Branch 🌿

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! πŸ‘

Thanks! ❀️❀️❀️

0 comments on commit 24fb60f

Please sign in to comment.