Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (36 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.44 KB
Raw

Contributing to pdf-ops

Welcome! We appreciate your interest in contributing to Pdf-Ops. This document will provide you with the information you need to get started.

Prerequisite

  • You should have some knowledge of javascript/typescript
  • Go through README and try implementing all the features on your local device.

How to contribute

There are several ways to contribute to Pdf-Ops:

  • Report a bug or a feature request
  • Fix a bug or implement a feature
  • Improve the documentation

Reporting bugs or feature requests

If you encounter a bug or have a feature request, please open an - issue on our GitHub repository. Please provide as much detail as possible, including steps to reproduce the issue or a clear - description of the feature request.

Fixing bugs or implementing features

We welcome contributions to fix bugs or implement new features. To contribute, please follow these steps:

  • Fork the Pdf-Ops repository on GitHub.
  • Clone your fork to your local machine.
  • Install the necessary dependencies by running npm install.
  • Create a new branch for your changes with a descriptive name (git checkout -b my-new-branch).
  • Make your changes and commit them with a descriptive commit message.
  • Push your changes to your fork (git push origin my-new-branch).
  • Open a pull request against the main branch of the Pdf-Ops repository.

Improving the documentation

Improving the documentation is a great way to contribute to Pdf-Ops. To contribute, please follow these steps:

  • Fork the Pdf-Ops repository on GitHub.
  • Clone your fork to your local machine.
  • Install the necessary dependencies by running npm install.
  • Create a new branch for your changes with a descriptive name (git - checkout -b my-new-branch).
  • Make your changes and commit them with a descriptive commit message.
  • Push your changes to your fork (git push origin my-new-branch).
  • Open a pull request against the main branch of the Pdf-Ops repository.

Please make sure to update the relevant documentation files and ensure that your changes are clear and easy to understand.

Code of conduct

We expect all contributors to follow our code of conduct. You can find our code of conduct in the CODE_OF_CONDUCT.md file.

License

By contributing to Pdf-Ops, you agree that your contributions will be licensed under the LICENSE file in the root directory of the Pdf-Ops repository.

Thank you for your interest in contributing to Pdf-Ops!