Skip to content

Latest commit

 

History

History
250 lines (172 loc) · 10.7 KB

CONTRIBUTING.md

File metadata and controls

250 lines (172 loc) · 10.7 KB
Raw

Contributing

We'd love for you to contribute to our source code and to make Momentum UI even better than it is today! Below are the guidelines to follow.

Table of Contents

Got a Question, Issue or Idea?

If you have questions about how to use a component or element in Momentum-UI, please look through the documentation first. If you still need help, please direct your questions to the Toolkit Q&A Webex Teams space. Request an Invite to the Teams space

Found an Issue?

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

Guidelines to report an Issue

Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Please provide the following information to increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - Explain what issue you are seeing and attach a screenshot if possible.
  • Motivation for or Use Case - Explain why this is a bug
  • Momentum-UI Version(s) - What library(ies) and version(s) are you using?
  • Browsers and Operating System - Which browsers did you find the problem on?
  • Reproduce the Error - Provide a live example (using CodeSandbox or StackBlitz) or a unambiguous set of steps.
  • Related Issues - Has a similar issue been reported before?
  • Suggest a Fix - If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Want a Feature?

You can request a new feature by requesting it in our Toolkit Q&A Webex Teams space. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first in our Toolkit Q&A Webex Teams space so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Changes can be crafted and submitted to our GitHub Repository as a Pull Request.

Requirements

To contribute to @momentum-ui, you need to have >=Node 8.10.0 and Yarn installed globally on your machine.

Setting Up Your Local Development Environment

Setup your repository

  • git clone git@github.com:momentum-design/momentum-ui.git
  • origin should be the above momentum-ui repo (git remote -v to see remote details)
  • You should work from a fork of the project. From the GitHub repository, click on the Fork button on the upper right-hand side to fork.
  • Add the fork as a remote to the project: git remote add <username> https://github.com/<username>/momentum-ui.git (replace with your username)

Installing the project

  • install node.js version >=v 8.0.0: http://nodejs.org/download/
  • install Yarn globally if you do not already have it on your machine: npm install yarn -g
  • Run package managers in the cloned project to pull dependencies: yarn install && yarn bootstrap

Contibuing to the Libraries

Check out the individual CONTRIBUTING docs for the library that you wish to contribute to for library specific instructions:

Git Commit Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the Angular change log.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Footer should contain a closing reference to an issue if any.

Samples: (even more samples)

docs(changelog): update change log to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • chore: Other changes that don't modify src or test files

Scope

The scope could be anything specifying place of the commit change. For example Compiler, ElementInjector, etc.

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Referencing issues Closed bugs should be listed on a separate line in the footer prefixed with "Closes" keyword like this:

Closes #234

or in case of multiple issues:

Closes #123, Closes #245, Closes #992

Submitting a Code Review

  • Before pushing to a PR, always use git pull --rebase
  • After git pulls, run yarn bootstrap:clean at the repo root (momentum-ui) to make sure to pull new dependencies. (For setting up your local environment, see above.)

Before you submit your pull request consider the following guidelines:

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

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch main

  • Create your patch, including appropriate test cases.

  • Follow our Coding Rules.

  • Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to the commit message conventions is required because release notes are automatically generated from these messages.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Build your changes locally to ensure all the tests pass:

    yarn build

  • Push your branch to GitHub:

    git push <username> my-fix-branch

  • In GitHub, send a pull request to momentum-design/momentum-ui:main.

  • If we suggest changes then:

    • Make the required updates.
    • Re-run the @momentum-ui test suite to ensure tests are still passing.
    • Commit your changes to your branch (e.g. my-fix-branch).
    • Push the changes to your GitHub repository (this will update your Pull Request).

  • If the PR gets too outdated we may ask you to rebase and force push to update the PR:

    git rebase main -i
git push <username> my-fix-branch -f

WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push <username> --delete my-fix-branch

  • Check out the main branch:

    git checkout main -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your main with the latest upstream version:

    git pull --ff upstream main

License

By contributing your code to the @momentum-ui GitHub repository, you agree to license your contribution under the MIT license.