Skip to content

Commit 0983929

Browse files
authored
feat: Update the contributing guidelines
1 parent 29a9712 commit 0983929

1 file changed

Lines changed: 19 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CONTRIBUTING OVERVIEW
1+
# Contributing guidelines ⚡️
22

33
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/) [![License](https://img.shields.io/github/license/web3community/devprotocol.xyz)](https://github.com/web3community/devprotocol.xyz/blob/main/LICENSE)
44

@@ -9,65 +9,72 @@
99
The following is a set of guidelines for contributing to this repository. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
1010

1111

12-
## 🚀 How to Contribute:
12+
## 🚀 How to Contribute
1313

14-
- Please create an [issue](https://github.com/web3community/devprotocol.xyz/issues) first before creating a Pull request.
14+
- Please create an [issue](https://github.com/web3community/devprotocol.xyz/issues) before creating a pull request.
1515

16-
- Fork the Repo and create a Branch for any Issue that you are working upon.
16+
- Fork the repository and create a branch for any issue that you are working on.
1717

18-
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
18+
- Create a pull request which will be promptly reviewed and suggestions would be added to improve it.
1919

2020
- Add Screenshots to help us know what changes you have done.
2121

22-
## 🤔 How to make a Pull Request:
22+
## 🤔 How to make a pull request
2323

2424
**1.** Fork [this](https://github.com/web3community/devprotocol.xyz) repository. Click on the <a href="https://github.com/web3community/devprotocol.xyz"><img src="https://img.icons8.com/fluency/30/000000/code-fork.png"/></a> symbol at the top right corner.
2525

2626
**2.** Clone the forked repository.
27+
2728
```bash
2829
git clone https://github.com/<your-username>/devprotocol.xyz.git
2930
```
3031

3132
**3.** Navigate to the project directory.
33+
3234
```bash
3335
cd devprotocol.xyz
3436
```
3537

3638
**4.** Create a new branch:
39+
3740
```bash
3841
git checkout -b your-branch-name
3942
```
4043

41-
**5.** Make the necessary changes in source code.
44+
**5.** Make the necessary changes in the source code.
4245

4346
**6.** Stage your changes and commit
47+
4448
```bash
4549
git add .
4650
git commit -m "<your_commit_message>"
4751
```
4852
*You can use appropriate emojis for your commit messages from [Gitmoji](https://gitmoji.dev/)*
4953

5054
**7.** Push your local commits to the remote repo.
55+
5156
```bash
5257
git push origin your-branch-name
5358
```
5459

5560
**8.** Create a new [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) from ```your-branch-name```
5661

57-
**9.** 🎉 Congratulations! You've made your contribution.
62+
**9.** 🎉 Congratulations! You've made your first pull request! Now, you should just wait until the maintainers review your pull request.
5863

59-
## Hacktoberfest Guidelines:
64+
## Hacktoberfest Guidelines 🌳
6065

6166
#### Good Practice
67+
6268
- Comment on the issue to get assigned
6369
- Create an issue before you make a Pull Request
6470

6571
#### Bad Practice
66-
- Creating Pull Requests without Issue assignment will not be accepted and will be closed
6772

68-
After this, project maintainers will review the changes and will merge your PR if they found it good, otherwise we will suggest the required changes.
73+
- Creating pull requests without issue assignment will not be accepted and will be closed.
74+
75+
After this, the project maintainers will review the changes and will merge your PR if they found it good, otherwise we will suggest the required changes.
6976

7077
## Web3Community
7178

7279
😕 Not sure where to start? Join our community on [Discord](https://discord.gg/37QFQ7J78B)
73-
✨ You can also take part in [Community Discussion](https://github.com/web3community/devprotocol.xyz/discussions)
80+
✨ You can also take part in [Community Discussion](https://github.com/web3community/devprotocol.xyz/discussions)

0 commit comments

Comments
 (0)