Skip to content

Latest commit

 

History

History
44 lines (40 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

44 lines (40 loc) · 1.12 KB

Contributing

Contributions are welcome! To get started, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine:
    git clone https://github.com/JeelGajera/jspdf-md-renderer
    cd jspdf-md-renderer
  3. Install dependencies:
    npm i
  4. Run the project locally:
    npm run dev
  5. Format the code using Prettier:
    npm run format
  6. Lint the code using ESLint:
    npm run lint
  7. Create a new branch for your feature or bugfix:
    git checkout -b feature-or-bugfix-name
  8. Make your changes and commit them:
    git add .
    git commit -m "Description of your changes"
  9. Push your changes to your forked repository:
    git push origin feature-or-bugfix-name
  10. Create a pull request on GitHub from your forked repository to the main repository.

Please ensure your code adheres to the project's coding standards and passes all checks before submitting a pull request.

Thank you for contributing!