Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

92 lines (60 loc) · 3.31 KB
Raw

Contribution Guidelines

This document contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new features to this project. Thank you for helping out and remember, no contribution is too small.

Submitting a change

Below you will find the process and workflow used to review and merge your changes.

Step 1 : Find existing issues

Step 2 : Fork the Project

  • Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.
git clone https://github.com/<your-username>/microweber
cd microweber
git remote add upstream https://github.com/microweber/microweber
  • If you have already forked the project, update your copy before working.
git remote update
git checkout master
git rebase upstream/master

Step 3 : Create your Branch

Create a new branch. Use its name to identify the issue your addressing.

# It will create a new branch with name template_branch_name and switch to that branch
git checkout -b my_branch_name

Step 4 : Create your fix and Commit

  • Create your fix.
  • Add all the files/folders needed.
  • After you've made changes or completed template creation, add changes to the branch you've just created by:
# To add all new files to branch template_branch_name
git add .
  • To commit, give a descriptive message for the convenience of the reviewer by:
# This message get associated with all files you have changed
git commit -m "Added/Fixed/Updated XXX issue"

NOTE:

  • A Pull Request should have only one unique isse fix to make it simple for review.
  • Multiple fixes for same issue can be grouped into single Pull Request.

Step 5 : Push Your Changes

  • Now you are ready to push your template to the remote (forked) repository.
  • When your work is ready and complies with the project conventions, upload your changes to your fork:
# To push your work to your remote repository
git push -u origin my_branch_name

Step 6 : Pull Request

  • Fire up your favorite browser, navigate to your GitHub repository, then click on the New pull request button within the Pull requests tab. Provide a meaningful name and description to your pull request, that describes the purpose of the template.
  • Voila! Your Pull Request has been submitted. It will be reviewed and merged by the moderators, if it complies with project standards, otherwise a feedback will be provided.

Need more help?

You can refer to the following articles of Git and GitHub basics.