Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (35 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 1.67 KB

Contributing to Page Processing Library

Thank you for considering contributing to our project! We welcome contributions from the community and are excited to see what you will bring to the table.

How to Contribute

  1. Fork the repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository in your GitHub account.

  2. Clone your fork: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/your-username/page-processing-lib.git

  3. Create a branch: Create a new branch for your feature or bug fix:

    git checkout -b my-feature-branch

  4. Make your changes: Implement your feature or bug fix.

  5. Commit your changes: Commit your changes with a clear and concise commit message:

    git add .
git commit -m "Add feature/fix bug: description"

  6. Push to your fork: Push your changes to your forked repository:

    git push origin my-feature-branch

  7. Create a Pull Request: Open a pull request to the main repository. Provide a clear description of your changes and any relevant information.

Code Style

Please ensure your code adheres to the following style guidelines:

  • Follow the existing code style and conventions.
  • Write clear and concise comments where necessary.
  • Ensure your code is well-documented.

Testing

Please write tests for your changes and ensure all existing tests pass before submitting your pull request. Run the tests using the following command:

npm run test

Thank You!

Thank you for your contributions! Your support is greatly appreciated.