Skip to content

Latest commit

 

History

History
78 lines (74 loc) · 3.8 KB

Guidelines.md

File metadata and controls

78 lines (74 loc) · 3.8 KB

Guidelines

image

Contributing to 👣 Fnplus Open Source Projects

Fnplus welcomes contributions to open source projects on Github. When contributing, please follow the Code of Conduct.

Issues

Feel free to submit issues and enhancement requests. All requests would be entertained with respect to CODE OF CONDUCT. We welcome your ideas and creativity.

Contributing

Setting Up GitHub And Git For The First Time

Get a github account

Download and install git

Check by typing git version in the terminal

Set up git with your user name and email

Open a terminal/shell and type

git config --global user.name "Your name here"
git config --global user.email "your_email@example.com"

(Don’t type the $; that just indicates that you’re doing this at the command line.) For any technical issues while setting up visit this page by Github —
Getting Started With Github

1. Fork the project

Click on the FORK icon on top right of your screen . fork-image

2. Clone the Project

After the step 1, you have to click on the Green Colored “Clone or download” button and copy the web-URL . clone_url-image

3. Open GitBash Software

Open Terminal/Command Line and write the command

git clone <link you copied> e.g
git clone https://github.com/YOUR-USERNAME/ProjectName

Press Enter. Your local clone will be created. Then, go to footsteps-app (cd footsteps-app) and do git remote add upstream https://github.com/fnplus/footsteps-app.git (use git@github.com:fnplus/footsteps-app.git if using SSH) to add a remote called upstream and link it to Footsteps's main repository (this will be used to merge with the latest version on develop and also to prevent running lint checks on merge commits when you later update your local branch with upstream/master). If your upstream is not set correctly, the lint checks will run on merge commits as well. The way to fix this will be to update the upstream URL by running the following command: git remote set-url upstream https://github.com/fnplus/footsteps-app.git (use git@github.com:fnplus/footsteps-app.git if using SSH)

4. Update your local repository and create your separate Branch

To create a separate branch write this command on Github —

git fetch upstream
git checkout develop
git merge upstream/develop
git checkout -b your-branch-name 

This will update your local repo with latest changes and also create a new branch with name as your-branch-name. If you find any difficulty, please check Fork a repo-Github Help

Tip: Always work on a new branch and don’t mess up the master branch

5. Open the project

Now, Open the project in your local device. It will be in the directory where you cloned the project. After opening the project, make some meaningful changes to the project(Add features, Modify existing code, Add files/Readme.md) .

6. Add your changes

To add all the changes you made write the command

git add .

7. Commit Changes

Commit all your changes using the command

git commit -m "commit message"

9. Push Your Code

git push -u origin <name_of_your_new_branch>

10. Pull Request

To create a pull request that is ready for review, click Create Pull Request. For more information about creating pull requests, see “About pull requests.”

pull_request-image

git_cheet_sheet-image

👍 Hurrah! You are all set to contribute to the Open Source Community

open_source-image

⚡️⚡️⚡️⚡️ Enjoy Contributing