Skip to content

Commit

Permalink
Merge pull request #35 from web3community/update_contributing_guidelines
Browse files Browse the repository at this point in the history
feat: Update the contributing guidelines
  • Loading branch information
vinzvinci authored Oct 8, 2021
2 parents 636f31a + 0983929 commit cb3f263
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CONTRIBUTING OVERVIEW
# Contributing guidelines ⚡️

[![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)

Expand All @@ -9,65 +9,72 @@
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:
## 🚀 How to Contribute

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

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

- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
- 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:
## 🤔 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.
**5.** Make the necessary changes in the 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```

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

## Hacktoberfest Guidelines:
## 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.
- Creating pull requests without issue assignment will not be accepted and will be closed.

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.

## 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)
✨ You can also take part in [Community Discussion](https://github.com/web3community/devprotocol.xyz/discussions)

0 comments on commit cb3f263

Please sign in to comment.