Skip to content

Latest commit

 

History

History
57 lines (29 loc) · 1.56 KB

CONTRIBUTION.md

File metadata and controls

57 lines (29 loc) · 1.56 KB

How to Contribute

If you think that you can add a new feature or want to fix a bug, we invite you to contribute to football-team-flags and make this project better. To start contributing, follow the below instructions:

  1. Fork this repository

  2. Clone your forked repository of project

git clone https://github.com/<your_username>/football-team-flags.git

  1. Navigate to the project directory:

cd football-team-flags

  1. Add a reference(remote) to the original repository:

git remote add upstream https://github.com/laisfrigerio/football-team-flags.git

  1. Check the remotes for this repository:

git remote -v

  1. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository:

git pull upstream main

  1. Create a new branch (prefer a branch name that relates to your assigned issue):

git checkout -b <YOUR_BRANCH_NAME>

  1. Perform your desired changes to the code base

  2. Check your changes:

git status

git diff

  1. Stage your changes:

git add . <\files_that_you_made_changes>

  1. Commit your changes:

git commit -m "relavant message"

  1. Push the committed changes in your feature branch to your remote repository:

git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests

  2. Add an appropriate title and description to your PR explaining your changes

  3. Click on Create pull request

Congratulations 🎉, you have made a PR to the football-team-flags. Wait for your submission to be accepted and your PR to be merged by a maintainer.