Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2.07 KB
Raw

Contributing

Pull requests of any kind are welcome from the community, and if you're reading this I am really happy that you have decided to contribute. You rock! When contributing to this repository, please first discuss the change you wish to make via a GitHub issue with the owners of this repository before making a change.

Please note we have a Code of Conduct, please follow it in all of your interactions with this project.

Development Setup

Installation:

  1. Clone the project git clone git@github.com:matt-d-rat/react-middle-truncate.git
  2. Install npm dependencies npm install

Running the demo app:

npm start

Running Eslint

npm run check

Running the tests:

Mocha

npm run test

npm run test:watch

Karma (in-browser)

npm run test:karma

Test coverage

npm run cover

Pull Request Process

  1. Please include all relevant information regarding your change in the Pull Request. A template has been provided detailing the key information needed to appropriately understand the context of your requested change.
  2. Ensure that your changes are limited to the same scope as discussed in the associated GitHub issue.
  3. Code changes should follow the same coding conventions as defined by the ESlint rules for this project.
  4. Update existing tests and add new tests pertinent to your change(s).
  5. Test your changes against multiple major versions of React. Consult the package.json for the minimum versions this library supports.
  6. Update any associated documentation which are impacted by your changes, namely the README.md.

Code of Conduct

When contributing to this project, whether that is through raising issues, taking part in discussions, or raising pull requests please ensure that you are following the project Code of Conduct.