Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

70 lines (44 loc) · 2.39 KB

Contributing Guidelines

Thanks for your interest in contributing to Plagiarism Checker! Contributing to open source projects like this one are a rewarding way to learn, and build experience. Not only that, contributing is a great way to get involved with social coding. We are excited to see what amazing contributions you will make, as well as how your contributions will benefit others.

If you are new to contributing to open source projects, the process can be quite confusing. Not to worry! To help ensure both you and the community get the most out of your contributions, we've put together the following guidelines.

Ways of Contributing

A developer can contribute in the following ways:

  1. Take a look at the open issues and find one you can tackle.
  2. Locate and fix bugs.
  3. Ideate and implement new features.
  4. Improve tooling and testing.
  5. Improve the code quality.

Ground Rules of contribution

Kindly check the code of conduct prior to contributing.

How to Contribute

If you'd like to contribute, a good place to start is by searching through the issues and pull requests to see if someone else had a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of the project, you should:

  1. Minor Contribution (e.g., typo fix): Open a pull request
  2. Major Contribution (e.g., new feature): Start by opening an issue first. That way, other people can weigh in on the discussion and planning before you do any work.

Steps to contribute

  1. Fork the project.
  2. Clone the your fork.
git clone https://github.com/<YOUR-USERNAME>/Plagiarism-checker
  1. Add a new remote to upstream
git remote add upstream https://github.com/ElzaCS/Plagiarism-checker
  1. Create a new branch from the current branch
git checkout -b <YOUR-NEW-BRANCH>

  1. Work on the new branch.

  2. Add or change documentation as needed.

  3. Before pushing the code, pull from upstream and check if there are any conflicts. If so solve them and then push the code.

git pull --rebase upstream master
  1. Push the code to the origin
git push origin <YOUR-NEW-BRANCH>

  1. From your forked repository, open a new pull request to the project's development branch.

  2. Once the pull request is approved and merged, you can pull the changes from upstream to your local repository and delete your extra branch(es).

Happy Coding!