Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

43 lines (22 loc) · 1.53 KB
Raw

Contributing to use font from content

As the creators and maintainers of this project, we want to ensure that react-content-font lives and continues to grow and evolve. We would like to encourage everyone to help and support this library by contributing.

Code contributions

Here is a quick guide to doing code contributions to the library.

  1. Fork and clone the repo to your local machine git clone https://github.com/YOUR_NAME/react-content-font.git

  2. Create a new branch from main with a meaningful name for a new feature or an issue you want to work on: git checkout -b your-branch-name

  3. Install packages by running:

    npm install

  4. If you've added a code that should be tested, ensure the test suite still passes.

    npm test

  5. Try to write some unit tests to cover as much of your code as possible.

  6. Ensure your code lints without errors.

    npm run lint

  7. Ensure build passes.

    npm run build

  8. Push your branch: git push -u origin your-branch-name

  9. Submit a pull request to the upstream react-content-font repository.

  10. Choose a descriptive title and describe your changes briefly.

Coding style

Please follow the coding style of the project. use font from content uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback. The linting can be run manually with the following command: npm run lint

License

By contributing your code to the react-content-font GitHub repository, you agree to license your contribution under the MIT license.