Skip to content

Latest commit

 

History

History
24 lines (20 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

24 lines (20 loc) · 1.46 KB

The only official and maintained Sejda repository is https://github.com/torakiki/sejda/ and its issue tracker is the place where you should post and discuss feature requests and proposals.

Before you post

  • Make sure the same request has not been posted already by searching among the open and closed issues.
  • Make sure the feature you are looking for is not already there, look at the documentation on sejda.org, stackoverflow and the code.

Open an issue

You verified the points above and you want to open an issue.

  • Be descriptive, clearly explain what the issue is.
  • If it's a bug, include a clear example or the steps to reproduce it
  • If it's a feature request, try to clearly explain the use case. We don't include features that are too specific or of no use for the other users. On the other hand we are happy to include features other users may benefit from.

Code contribution

  • we need you to sign our CLA.
  • Before starting to write large amounts of code talk to us. Open an issue or send us an email, we can discuss together how to proceed.
  • We are very strict with the code style. Code format and templates for the Eclipse IDE are included in the sejda-docs module as well as the checkstyle plugin configuration, use them.
  • Include unit tests to cover your feature or bugfix.