Skip to content
This repository has been archived by the owner on Jan 27, 2021. It is now read-only.

Latest commit

 

History

History
57 lines (34 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

57 lines (34 loc) · 2.33 KB
Raw

Contributing guidelines

Issues and Bugs

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to this repo. Even better you can submit a Pull Request with a fix.

Feature Requests

You can request a new feature by submitting an issue to this repo. Proposed features (with suitable design documentation and reasoning) can be crafted and submitted to this repo as a Pull Request.

Submission Guidelines

  1. Fork the project.
  2. Clone forked project.
  3. Once cloned, you will see origin as your default remote, pointing to your personal forked repository. Add a remote named upstream pointing to the main umich-lib-ui:
git remote add upstream git@github.com:mlibrary/umich-lib-ui.git
git remote -v

Submitting an Issue

Before you submit your issue, search the repository. Maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.

Submitting a Pull Request

  1. Search this repository for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  2. Pull the latest master branch from upstream:

git pull upstream master
  1. Always work and submit pull requests from a branch. Do not submit pull requests from the master branch of your fork.
git checkout -b { YOUR_BRANCH_NAME } master

  1. Commit your changes using a descriptive commit message. Use npm run commit to handle semantic commits.

  2. Once ready for feedback from other contributors and maintainers, push your commits to your fork:

git push origin { YOUR_BRANCH_NAME }

  1. In Github, navigate to mlibrary/umich-lib-ui and click the button that reads "Compare & pull request".

  2. Write a title and description, then click "Create pull request". See How to write the perfect pull request for mroe details on writing good PRs.

  3. Stay up to date with the activity in your pull request. Maintainers will be reviewing your work and making comments, asking questions and suggesting changes to be made before they merge your code. When you need to make a change, add, commit and push to your branch normally.