Skip to content

Latest commit

 

History

History
144 lines (108 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

144 lines (108 loc) · 4.48 KB
Raw

Contribute to PeerLink 🌸

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

Table of Contents 📒

Code of Conduct 📝

This project and everyone participating in it is governed by the Peerlink Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]

Have a Question ❓

Before you ask a question, it is best to search for existing Issues that might help you. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification , we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

How to Contribute? 🎈

Getting Started with the Project ⚙

  1. Fork the repository

fork

  1. Clone the repository
git clone https://github.com/<your-github-username>/Peerlink.git
  1. Go into the directory containing the project, and get started
cd <project-directory>/Peerlink
  1. Take a look into directories for frontend and backend part
cd frontend

or,

cd backend
  1. Install the dependencies before executing it on your local system
npm install

Making a Pull Request 📢

  1. Before making a pull request Check existing Issues and click the issue you want to work on.

    Under that issue, write a comment asking permission for the admin of the repository to assign you the issue you want to work on.

For example,

  I would like to work on this issue. Can you assign it to me?
  1. After cloning the repository on your local machine you can switch to the cloned repository.
  cd Peerlink
  1. Create a new branch.
  git checkout -b <your-branch-name>
  1. After modifying the code, Stage your changes.
  git add .
  1. Commit the changes.
  git commit -m "Add <your-github-username>"
  1. Check the status of your repository.
  git status
  1. Push your repository to GitHub.
  git push origin <your-branch-name>

  1. Navigate to your forked repo, and you'll find a new section at the top of the files section with two Contribute and Fetch Upstream buttons!

  2. Click the Fetch Upstream button to bring up a drop-down menu; select the Fetch and Merge option from the menu to make uptoDate the forked repo.

  3. Click the Contribute button to bring up a drop-down menu; select the pull request option from the menu.

  4. But before making a pull request, be sure to link the issue in the description box for which you are creating the pull request. For Example,

  Fixes #10

Note: A pull request allows you to merge your changes into the main project.

Wait for your edits to be merged before proceeding.

Congrats!! Now you have added a significant pull request

Improving The Documentation 📓

Updating, improving and correcting the documentations are also welcome!

Other Ways to Support 🙌

To join the Project Team check out Diversion 2022 and Register with peerlink.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues