How to start contributing?

Set up the repo

• Fork the repo to your profile

• Clone your forked repo:

git clone https://github.com/<your_profile>/cf-analytics-chrome-extension.git

• Set the main repo as remote upstream:

git remote add upstream https://github.com/next2solve/cf-analytics-chrome-extension.git

• Now if you run git remote -v, you should find your fork as remote origin and organization's repo as remote upstream

    git remote -v
    origin  https://github.com/<your_profile>/cf-analytics-chrome-extension.git (fetch)
    origin  https://github.com/<your_profile>/cf-analytics-chrome-extension.git (push)
    upstream        https://github.com/next2solve/cf-analytics-chrome-extension.git (fetch)
    upstream        https://github.com/next2solve/cf-analytics-chrome-extension.git (push)

Create Pull Request

• Create a feature branch and push your changes to origin

    git push origin <feature-branch-name>

• Once you're done implementing the feature(/fix),
  • Go to your profile on Github and select the repository
  • Click Pull request tab
  • Either click New pull request and create a Pull Request from your fork's feature branch to organization's repo's master branch
  • Or click Compare and pull request from suggestion and it'll create pull request suggest with appropriate configuration like above (this is doable from organization's repo as well)

Pull Request Format

• Add some description explaining the changes if required
• In case of UI change, add explanatory screenshot/gif

Keep everything in sync

• Fetch latest from upstream

    git fetch upstream

• Merge local master with remote upstream master

    git merge upstream/master

• Push them to remote origin

    git push origin master