Skip to content

contributing.md

Latest commit

 

History

History
39 lines (27 loc) · 2.08 KB

contributing.md

File metadata and controls

39 lines (27 loc) · 2.08 KB

Contributing

Thank you for contributing to the Mavenlink Design System! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Code of Conduct

Mavenlink has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Submitting Changes

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. Make your changes. Be sure to look at our component design principles!
  3. Add or update tests if necessary. Be sure to look at our testing philosophy!
  4. If updating an exported component, add an entry in the "unreleased" section of the changelog. See this example commit.
  5. Ensure the test suite passes by running yarn test
  6. Ensure the linter passes by running yarn lint
  7. Make a pull request
  8. Verify the Github Page is working appropriate. The URL is of the form https://mavenlink.github.io/design-system/$BRANCH where $BRANCH is the branch name.

Running the app locally

yarn start

and visit localhost:6060 in your browser.

MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Reporting Bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue. Please provide details, background, and sample code if possible.

Tips

  • yarn test -o runs only changed test files