Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (53 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

72 lines (53 loc) · 2.43 KB

Contributing to @libresign/pdf-elements

Thank you for your interest in contributing to @libresign/pdf-elements! We welcome contributions from the community.

Code of Conduct

This project follows the LibreSign Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a detailed description of the suggested enhancement
  • Provide examples of how the enhancement would be used
  • Explain why this enhancement would be useful

Pull Requests

  • Fill in the required template
  • Follow the JavaScript/Vue.js style guide
  • Include SPDX headers in all new files
  • Update the README.md with details of changes if needed
  • Update the CHANGELOG.md following Keep a Changelog format
  • Ensure all tests pass and linting is clean

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/pdf-elements.git
  3. Install dependencies: npm install
  4. Create a feature branch: git checkout -b my-feature
  5. Make your changes
  6. Run lint: npm run lint
  7. Build the library: npm run build:lib
  8. Commit your changes: git commit -am 'Add some feature'
  9. Push to the branch: git push origin my-feature
  10. Create a Pull Request

Coding Standards

  • Use 2 spaces for indentation
  • Follow Vue.js style guide
  • Add SPDX headers to all source files: 
    // SPDX-FileCopyrightText: 2026 LibreCode coop and contributors
// SPDX-License-Identifier: AGPL-3.0-or-later
  • Write meaningful commit messages
  • Keep pull requests focused on a single feature or fix

License

By contributing, you agree that your contributions will be licensed under AGPL-3.0-or-later.