Skip to content

Latest commit

 

History

History
119 lines (75 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

119 lines (75 loc) · 2.77 KB
Raw

Contributing

We will follow ModOpt policy concerning contributions.

Pull Requests

If you would like to take a more active roll in the development of MCCD you can do so by submitting a "Pull request". A Pull Requests (PR) is a way by which a user can submit modifications or additions to the MCCD package directly. PRs need to be reviewed by the package moderators and if accepted are merged into the master branch of the repository.

Before making a PR, be sure to carefully read the following guidelines.

Before Making a PR

The following steps should be followed before making a pull request:

  1. Log into your GitHub account or create an account if you do not already have one.

  2. Go to the main MCCD repository page: https://github.com/CosmoStat/mccd

  3. Fork the repository, i.e. press the button on the top right with this symbol . This will create an independent copy of the repository on your account.

  4. Clone your fork of ModOpt.

  git clone https://github.com/YOUR_USERNAME/mccd
  1. Add the original repository (upstream) to remote.
  git remote add upstream https://github.com/CosmoStat/mccd

Making a PR

The following steps should be followed to make a pull request:

  1. Pull the latest updates to the original repository.
  git pull upstream master
  1. Create a new branch for your modifications.
  git checkout -b BRANCH_NAME

  1. Make the desired modifications to the relevant modules.

  2. Add the modified files to the staging area.

  git add .
  1. Make sure all of the appropriate files have been staged. Note that all files listed in green will be included in the following commit.
  git status
  1. Commit the changes with an appropriate description.
  git commit -m "Description of commit"
  1. Push the commits to a branch on your fork of MCCD.
  git push origin BRANCH_NAME

  1. Make a pull request for your branch with a clear description of what has been done, why and what issues this relates to.

  2. Wait for feedback and repeat steps 3 through 7 if necessary.

After Making a PR

If your PR is accepted and merged it is recommended that the following steps be followed to keep your fork up to date.

  1. Make sure you switch back to your local master branch.
  git checkout master
  1. Delete the local branch you used for the PR.
  git branch -d BRANCH_NAME
  1. Pull the latest updates to the original repository, which include your PR changes.
  git pull upstream master
  1. Push the commits to your fork.
  git push origin master