-
Notifications
You must be signed in to change notification settings - Fork 20
Add contributing guidelines #26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
5453c0f
Added contributing guidelines
inomag 61a54ae
Updated License
inomag 379e70a
Update CONTRIBUTING.md
inomag 28781dd
Update CONTRIBUTING.md
inomag 3b155cd
Update CONTRIBUTING.md
inomag 74214ca
Update CONTRIBUTING.md
inomag bed2dd1
Update CONTRIBUTING.md
inomag c5e7aa9
Update CONTRIBUTING.md
inomag 6bad8c2
Update CONTRIBUTING.md
inomag 582a0d7
Update CONTRIBUTING.md
shuklaritvik06 14351f5
Update CONTRIBUTING.md
shuklaritvik06 06ae4df
Update CONTRIBUTING.md
shuklaritvik06 edf1e5a
Update CONTRIBUTING.md
shuklaritvik06 b9f7548
Update CONTRIBUTING.md
shuklaritvik06 f75f94c
Update CONTRIBUTING.md
shuklaritvik06 8aae3b2
Update CONTRIBUTING.md
shuklaritvik06 1ab8a6a
Update CONTRIBUTING.md
shuklaritvik06 e247c15
Update CONTRIBUTING.md
shuklaritvik06 dcf75aa
Update CONTRIBUTING.md
shuklaritvik06 406ac8d
Update CONTRIBUTING.md
shuklaritvik06 dcfa8ff
Update CONTRIBUTING.md
shuklaritvik06 89b3299
Update CONTRIBUTING.md
shuklaritvik06 ac4ee7e
Update CONTRIBUTING.md
shuklaritvik06 6d06f00
Update CONTRIBUTING.md
shuklaritvik06 d91ab3b
Update CONTRIBUTING.md
shuklaritvik06 6ebe9b0
Update CONTRIBUTING.md
shuklaritvik06 3cc9abd
Update CONTRIBUTING.md
shuklaritvik06 03e8dac
Update CONTRIBUTING.md
shuklaritvik06 e7cfb21
Update CONTRIBUTING.md
kkrishguptaa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # CONTRIBUTING OVERVIEW | ||
|
|
||
| [](http://makeapullrequest.com) [](https://github.com/ellerbrock/open-source-badges/) [](https://github.com/web3community/devprotocol.xyz/blob/main/LICENSE) | ||
|
|
||
|
|
||
| *👍🎉 First off, thanks for taking the time to contribute! 🎉👍* | ||
|
gptkrsh marked this conversation as resolved.
|
||
|
|
||
|
shuklaritvik06 marked this conversation as resolved.
|
||
|
|
||
|
shuklaritvik06 marked this conversation as resolved.
|
||
| 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. | ||
|
|
||
|
|
||
| ## 🚀 How to Contribute: | ||
|
|
||
| - Please create an [issue](https://github.com/web3community/devprotocol.xyz/issues) first before creating a Pull request. | ||
|
|
||
| - Fork the Repo and create a Branch for any Issue that you are working upon. | ||
|
|
||
| - Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it. | ||
|
|
||
| - Add Screenshots to help us know what changes you have done. | ||
|
|
||
| ## 🤔 How to make a Pull Request: | ||
|
|
||
| **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. | ||
|
|
||
| **2.** Clone the forked repository. | ||
| ```bash | ||
| git clone https://github.com/<your-username>/devprotocol.xyz.git | ||
| ``` | ||
|
|
||
| **3.** Navigate to the project directory. | ||
| ```bash | ||
| cd devprotocol.xyz | ||
| ``` | ||
|
|
||
| **4.** Create a new branch: | ||
| ```bash | ||
| git checkout -b your-branch-name | ||
| ``` | ||
|
|
||
| **5.** Make the necessary changes in source code. | ||
|
|
||
| **6.** Stage your changes and commit | ||
| ```bash | ||
| git add . | ||
| git commit -m "<your_commit_message>" | ||
| ``` | ||
| *You can use appropriate emojis for your commit messages from [Gitmoji](https://gitmoji.dev/)* | ||
|
|
||
| **7.** Push your local commits to the remote repo. | ||
| ```bash | ||
| git push origin your-branch-name | ||
| ``` | ||
|
|
||
| **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``` | ||
|
|
||
|
shuklaritvik06 marked this conversation as resolved.
|
||
| **9.** 🎉 Congratulations! You've made your contribution. | ||
|
|
||
| ## Hacktoberfest Guidelines: | ||
|
|
||
| #### Good Practice | ||
| - Comment on the issue to get assigned | ||
| - Create an issue before you make a Pull Request | ||
|
|
||
| #### Bad Practice | ||
| - Creating Pull Requests without Issue assignment will not be accepted and will be closed | ||
|
|
||
| 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. | ||
|
|
||
| ## Web3Community | ||
|
|
||
| 😕 Not sure where to start? Join our community on [Discord](https://discord.gg/37QFQ7J78B) | ||
| ✨ You can also take part in [Community Discussion](https://github.com/web3community/devprotocol.xyz/discussions) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.