Skip to content

Commit aeb32e3

Browse files
Merge pull request #43 from web3community/improve_contributing_guidelines
docs: Improve the contributing guidelines
2 parents f7e07c3 + 583a09b commit aeb32e3

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
# Contributing Guidelines
22

3-
🎉 First of all, thanks for taking the time to contribute! 🎉
3+
🎉 **First of all, thanks for taking the time to contribute!** 🎉
44

55
The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
66

7-
## Code of Conduct
7+
## Code of Conduct 📜
88

9-
This project and everyone participating in it is governed by a [Code of Conduct](https://github.com/web3community/devprotcol.xyz/blob/main/code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [@vinzvinci](https://github.com/vinzvinci)
9+
This project and everyone participating in it is governed by a [Code of Conduct](https://github.com/web3community/devprotcol.xyz/blob/main/code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [@vinzvinci](https://github.com/vinzvinci) or in our [Discord server](https://discord.gg/TSRwqx4K2v).
1010

11-
## How Can I Contribute?
11+
## How can I contribute? 🤔
1212

13-
### Reporting Bugs
13+
### Reporting Bugs 💣
1414

1515
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
1616

1717
Since the new GitHub Issue forms we only suggest you to include most information possible. But you can also **Perform a [cursory search](https://github.com/web3community/devprotocol.xyz/issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
1818

1919
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
2020
21-
### Suggesting Enhancements
21+
### Suggesting Enhancements 🛠
2222

2323
This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
2424

2525
Since the new GitHub Issue forms we only suggest you to include most information possible. But you can also **Perform a [cursory search](https://github.com/web3community/devprotocol.xyz/issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
2626

2727
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
2828
29-
### Your First Code Contribution
29+
### Your First Code Contribution 🟩
3030

3131
Unsure where to begin contributing to this project? You can start by looking through these `beginner` and `help-wanted` issues:
3232

3333
- [Beginner issues](https://github.com/web3community/devprotocol.xyz/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) - issues which should only require a few lines of code, and a test or two.
3434
- [Help wanted issues](https://github.com/web3community/devprotocol.xyz/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) - issues which should be a bit more involved than `beginner` issues.
3535

36-
### Pull Requests
36+
### Pull Requests 📣
3737

3838
The process described here has several goals:
3939

@@ -113,18 +113,18 @@ git push origin your-branch-name
113113

114114
## Hacktoberfest Guidelines 🌳
115115

116-
#### Good Practice
116+
#### Good Practice
117117

118118
- Comment on the issue to get assigned
119119
- Create an issue before you make a Pull Request
120120

121-
#### Bad Practice
121+
#### Bad Practice
122122

123123
- Creating pull requests without issue assignment will not be accepted and will be closed.
124124

125125
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.
126126

127-
## Web3Community
127+
## Web3Community 🌐
128128

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

0 commit comments

Comments
 (0)