|
1 | | -# Contributing guidelines ⚡️ |
| 1 | +# Contributing Guidelines |
2 | 2 |
|
3 | | -[](http://makeapullrequest.com) [](https://github.com/ellerbrock/open-source-badges/) [](https://github.com/web3community/devprotocol.xyz/blob/main/LICENSE) |
| 3 | +🎉 First of all, thanks for taking the time to contribute! 🎉 |
4 | 4 |
|
| 5 | +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. |
5 | 6 |
|
6 | | -*👍🎉 First off, thanks for taking the time to contribute! 🎉👍* |
| 7 | +## Code of Conduct |
7 | 8 |
|
| 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) |
8 | 10 |
|
9 | | -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. |
| 11 | +## How Can I Contribute? |
10 | 12 |
|
| 13 | +### Reporting Bugs |
| 14 | + |
| 15 | +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 🔎. |
| 16 | + |
| 17 | +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. |
| 18 | + |
| 19 | +> **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. |
| 20 | +
|
| 21 | +### Suggesting Enhancements |
| 22 | + |
| 23 | +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 🔎. |
| 24 | + |
| 25 | +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. |
| 26 | + |
| 27 | +> **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. |
| 28 | +
|
| 29 | +### Your First Code Contribution |
| 30 | + |
| 31 | +Unsure where to begin contributing to this project? You can start by looking through these `beginner` and `help-wanted` issues: |
| 32 | + |
| 33 | +- [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. |
| 34 | +- [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. |
| 35 | + |
| 36 | +### Pull Requests |
| 37 | + |
| 38 | +The process described here has several goals: |
| 39 | + |
| 40 | +- Maintain the project's quality |
| 41 | +- Fix problems that are important to users |
| 42 | +- Engage the community in working toward the best possible! |
| 43 | +- Enable a sustainable system for maintainers to review contributions |
| 44 | + |
| 45 | +Please follow all instructions in [the template](https://github.com/web3community/devprotocol.xyz/blob/main/.github/pull_request_template.md) |
| 46 | + |
| 47 | +## Style Guide for Git Commit Messages :memo: |
| 48 | + |
| 49 | +**How you can add more value to your contribution logs:** |
| 50 | + |
| 51 | +- Use the present tense. (Example: "Add feature" instead of "Added feature") |
| 52 | +- Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...") |
| 53 | +- Limit the first line (also called the Subject Line) to *50 characters or less*. |
| 54 | +- Capitalize the Subject Line. |
| 55 | +- Separate subject from body with a blank line. |
| 56 | +- Do not end the subject line with a period. |
| 57 | +- Wrap the body at *72 characters*. |
| 58 | +- Use the body to explain the *what*, *why*, *vs*, and *how*. |
| 59 | +- Reference [Issues](https://github.com/web3community/devprotocol.xyz/issues) and [Pull Requests](https://github.com/web3community/devprotocol.xyz/pulls) liberally after the first line. |
| 60 | +- Follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) |
11 | 61 |
|
12 | 62 | ## 🚀 How to Contribute |
13 | 63 |
|
@@ -41,15 +91,15 @@ cd devprotocol.xyz |
41 | 91 | git checkout -b your-branch-name |
42 | 92 | ``` |
43 | 93 |
|
44 | | -**5.** Make the necessary changes in the source code. |
| 94 | +**5.** Make the necessary changes. |
45 | 95 |
|
46 | 96 | **6.** Stage your changes and commit |
47 | 97 |
|
48 | 98 | ```bash |
49 | 99 | git add . |
50 | 100 | git commit -m "<your_commit_message>" |
51 | 101 | ``` |
52 | | -*You can use appropriate emojis for your commit messages from [Gitmoji](https://gitmoji.dev/)* |
| 102 | +*Follow our commit guide from above* |
53 | 103 |
|
54 | 104 | **7.** Push your local commits to the remote repo. |
55 | 105 |
|
|
0 commit comments