|
1 | | -# CONTRIBUTING OVERVIEW |
| 1 | +# Contributing guidelines ⚡️ |
2 | 2 |
|
3 | 3 | [](http://makeapullrequest.com) [](https://github.com/ellerbrock/open-source-badges/) [](https://github.com/web3community/devprotocol.xyz/blob/main/LICENSE) |
4 | 4 |
|
|
9 | 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. |
10 | 10 |
|
11 | 11 |
|
12 | | -## 🚀 How to Contribute: |
| 12 | +## 🚀 How to Contribute |
13 | 13 |
|
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. |
15 | 15 |
|
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. |
17 | 17 |
|
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. |
19 | 19 |
|
20 | 20 | - Add Screenshots to help us know what changes you have done. |
21 | 21 |
|
22 | | -## 🤔 How to make a Pull Request: |
| 22 | +## 🤔 How to make a pull request |
23 | 23 |
|
24 | 24 | **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. |
25 | 25 |
|
26 | 26 | **2.** Clone the forked repository. |
| 27 | + |
27 | 28 | ```bash |
28 | 29 | git clone https://github.com/<your-username>/devprotocol.xyz.git |
29 | 30 | ``` |
30 | 31 |
|
31 | 32 | **3.** Navigate to the project directory. |
| 33 | + |
32 | 34 | ```bash |
33 | 35 | cd devprotocol.xyz |
34 | 36 | ``` |
35 | 37 |
|
36 | 38 | **4.** Create a new branch: |
| 39 | + |
37 | 40 | ```bash |
38 | 41 | git checkout -b your-branch-name |
39 | 42 | ``` |
40 | 43 |
|
41 | | -**5.** Make the necessary changes in source code. |
| 44 | +**5.** Make the necessary changes in the source code. |
42 | 45 |
|
43 | 46 | **6.** Stage your changes and commit |
| 47 | + |
44 | 48 | ```bash |
45 | 49 | git add . |
46 | 50 | git commit -m "<your_commit_message>" |
47 | 51 | ``` |
48 | 52 | *You can use appropriate emojis for your commit messages from [Gitmoji](https://gitmoji.dev/)* |
49 | 53 |
|
50 | 54 | **7.** Push your local commits to the remote repo. |
| 55 | + |
51 | 56 | ```bash |
52 | 57 | git push origin your-branch-name |
53 | 58 | ``` |
54 | 59 |
|
55 | 60 | **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``` |
56 | 61 |
|
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. |
58 | 63 |
|
59 | | -## Hacktoberfest Guidelines: |
| 64 | +## Hacktoberfest Guidelines 🌳 |
60 | 65 |
|
61 | 66 | #### Good Practice |
| 67 | + |
62 | 68 | - Comment on the issue to get assigned |
63 | 69 | - Create an issue before you make a Pull Request |
64 | 70 |
|
65 | 71 | #### Bad Practice |
66 | | -- Creating Pull Requests without Issue assignment will not be accepted and will be closed |
67 | 72 |
|
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. |
69 | 76 |
|
70 | 77 | ## Web3Community |
71 | 78 |
|
72 | 79 | 😕 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