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.
Installation:
- Clone the project
git clone [email protected]:matt-d-rat/react-middle-truncate.git - 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
- 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.
- Ensure that your changes are limited to the same scope as discussed in the associated GitHub issue.
- Code changes should follow the same coding conventions as defined by the ESlint rules for this project.
- Update existing tests and add new tests pertinent to your change(s).
- Test your changes against multiple major versions of React. Consult the package.json for the minimum versions this library supports.
- Update any associated documentation which are impacted by your changes, namely the README.md.
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.