Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 2.49 KB
Raw

Contributing

When contributing to this repository, please first check whether the issue you encounter or the request you have has already been logged. If not please create a New Issue.

Logging an Issue

  1. Make sure this issue has not already been raised. If a relevant issue has been closed already please reopen it or make a reference to it in a new issue.
  2. Add appropriate labels to the issue (e.g. Documentation)
  3. For minor issues, it is acceptable to describe the problem and offer a potential route to fix it. For more involved feature requests or bugs, please include the following details at the minimum:
For bugs:
  • current system OS
  • current browser user-agent and version
  • repository branch
  • steps to reproduce
  • stack trace or any console log. Those logs are accessible in most browsers by pressing Ctrl/cmd + shift + J.
For feature requests:
  • rationale
  • paint the feature step by step (in words)
  • mockup (optional)

Pull Request Process

  1. Pick an issue in the Issue tracker for the repository, and assign yourself before working on it so we don't have duplicated effort.

  2. Pull Request must be created against the dev branch.

  3. The name of the branch should be in lower case and follow the pattern: [fix,mnt,feat]/[free-text-summarizing-the-PR]-[issue-number] e.g feat/mygithubhandle-file-sharing-888

    • "fix" should be used when the Pull Request fixes a bug or something that is broken
    • "mnt" should be used for any chore, dependency upgrade, housekeeping
    • "feat" should be used for a new feature

    You can optionally add your GitHub handle to identify branches.

  4. If unsure about the specifics of implementing a particular issue, please make a Draft PR sooner rather than later, and start a discussion from there.

  5. When designing a new UI component, please make sure your changes are also reflected in the appropriate Storybook story.

  6. When merging a Pull Request, please make sure to squash and merge, to prevent having all the commit messages merged. Note: this is not the default behavior.

  7. You may merge the Pull Request in once you have the sign-off of 2 maintainers, or if you do not have permission to do that, you may request the reviewer to merge it for you.

Commit Messages

Please provide a meaningful message summarizing in a couple of words what the commit did.

Styleguides

All TypeScript code must adhere to the eslint-recommended. These rules are programmatically enforced by eslint in a pre-push hook.