Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.43 KB
Raw

Contributing to Namely Styleguide

The following is a set of guidelines for contributing to the Namely Styleguide, CSS architecture, and React component library. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Submitting Issues

  • You can create an issue here, but before doing that please read the notes below on submitting issues, and include as many details as possible with your report.
  • Include screenshots, animated GIFs, or screencasts whenever possible; they are immensely helpful.
  • Include the behavior and visuals you expected
  • Check the dev tools for errors to include
  • Perform a quick search to see if a similar issue has already been submitted

Pull Requests

  • Include screenshots, animated GIFs, or screencasts whenever possible.
  • Follow the coding styleguide
  • Update any documentation related to component, style, or pattern
  • Include any context/reasoning behind the PR to help us understand why this change should be made
  • Branch names should be prefixes with a descriptively:
    • "f/(branch-name)" for feature branches
    • "b/(branch-name)" for bug fix branches

Git Commit Messages

  • Use the declarative tense ("Adds feature" not "Added feature")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally