Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (25 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.86 KB

This page provides information about contributing to Underworld3's (aka Underworld’s) codebase.

For contributions of Underworld models or workflows, please see https://github.com/underworld-community

We welcome contributions to Underworld’s codebase in the form of:

  • Code changes.
  • Bug reports.
  • Suggestions / Requests.
  • Documentation modifications.

For Bug reports and Suggestions / Requests please submit an Issue on the Underworld GitHub Issue Tracker. Please tag the Issue with a given Label to help us assess the issue.

Click here to submit an Issue.

For Code / Documentation changes please submit a GitHub Pull Request (PR). This allows us to review and discuss the contributions before merging it into our development branch. For creating Pull Request (PR) we recommend following the workflow outlined on GitHub.

More specifically:

  1. Fork Underworld via GitHub and clone it to your machine.
```bash
    git clone https://github.com/YOUR_GITHUB_ACCOUNT/underworld3
```
  1. Add the original Underworld repository as an additional remote source (named upsteam) for your local repo and pull down its latest changesets. Checkout to the upstream/development repo state, and then create a new local branch which will contain your forthcoming changes.
```bash
    git remote add upstream https://github.com/underworldcode/underworld3
    git pull upstream
    git checkout upstream/development
    git checkout -b newFeature
```

  1. Make your changes! Remember to write comments, write a test if applicable and follow the coding style of the project for details).

  2. Push your changes to your GitHub fork and then submit a PR to the development branch of Underworld via Github.