Skip to content

Latest commit

 

History

History
99 lines (73 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

99 lines (73 loc) · 3.61 KB

Contributing Guideline

First of all thanks for your time to contribute 😃 🥳

This documentation contains a set of guidelines to help you during the contribution process.


▶️ Steps for contributing :

Fork this repository

copy URL to clipboard


Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.


Clone This Repository

copy URL to clipboard

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone https://github.com/<Your-Github-username>/fix-your-nums.git

Create a branch

Change to the repository directory on your computer (if you are not already there):

cd fix-your-nums

Now create a branch using the git checkout command:

git checkout -b <branch-name>

For example:

git checkout -b add-new-calc

Make necessary changes and commit those changes

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add .

Now commit those changes using the git commit command:

git commit -m "Your commit message"

Push changes to GitHub

Push the changes to the forked repository using:

git push origin <Your-branch-name>

Navigate to the original repository and make a pull request.

In case of merge conflict fetch and merge from the remote repository .



🔑Guidelines

Here are some set of guidelines to follow while contributing to fix-your-nums :

  1. Welcome to this repository, if you are here as an open-source program participant/contributor.
  2. Participants/contributors have to comment on issues they would like to work on, and mentors or the PA will assign you.
  3. Issues will be assigned on a first-come, first-serve basis.
  4. Participants/contributors can also open their issues, but it needs to be verified and labelled by a mentor. We respect all your contributions, whether it is an Issue or a Pull Request.
  5. When you raise an issue, make sure you get it assigned to you before you start working on that project.
  6. Each participant/contributor will be assigned 1 issue (max) at a time to work.
  7. Don't create issues that are already listed.
  8. Please don't pick up an issue already assigned to someone else. Work on the issues after it gets assigned to you.
  9. Create your file in an appropriate folder with appropriate name and extension.
  10. Pull requests will be merged after being reviewed by mentor .
  11. We all are here to learn. You are allowed to make mistakes. That's how you learn, right!.

Are you a beginner in using Github?

You can refer to the following articles on the basics of Git and Github and also contact me, in case you are stuck: