Skip to content

Latest commit

 

History

History
143 lines (104 loc) · 6.35 KB

CONTRIBUTING.md

File metadata and controls

143 lines (104 loc) · 6.35 KB
Raw

This is a general guide if you want to report bugs, ask questions, request features or submitting patches. Please take a moment to review this document in order to make the process easy and effective for everyone involved.

This document is adapted from necolas/issue-guidelines

Table of Contents

Channels

A few channels are available to reach the developers, please find the most proper one for your purpose.

The Issue Tracker

The Issue Tracker is the best way for bug reports, features requests and submitting pull requests.

Please respect the following restrictions:

  • Do not post personal support requests, (e.g How can I call pdf2htmlEX in Java?). Use the mailing list, or Stack Overflow instead.
  • Keep the discussion on topic and respect the opinions of others.
  • Posts violating the above restrictions may be removed without any notification.

Issues may be closed due to the following reasons:

  • Fixed
  • Duplicate of other issues
  • Invalid / Won't fix / Off topic
  • Inactiviy (for unconfirmed issues)
  • Insufficient info (for unconfirmed issues)

In the last two cases, you can reopen the issue when you can provide more information.

The Mailing List

The Mailing list is set up for discussion and announcements. You are welcome to ask any question about pdf2htmlEX there. However do not report issues or submit patches there, since it's terrible to keep track of them.

Contacting the author

pdf2htmlEX is mostly written and maintained by 王璐 (Lu Wang). His email and twitter account can be found in README.md.

Please post only messages that do not fit into the above channels, otherwise note that he no longer replies with Please post your question to the mailing list or Please file an issue at GitHub, consider your message already replied.

Please expect a long delay，since the messages are usually archived and checked on a regular basis.

Guidance

Here are a few tips for different types of messages. Lots of your time may be saved if you follow the guidelines.

Ask questions

If you need any help or have issues using pdf2htmlEX, follow the following steps to get it resolved as fast as possible:

First of all, did you realize that your question might have been already answered in one of the following places?

If you cannot find anything useful there, do not hesitate to post in the mailing list. On the other hand, if you think it's something wrong about pdf2htmlEX, please report a bug instead.

It will help a lot if you provide detailed information as mentioned in the Bug Reports section.

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository. A perfect bug report may help the developer to identify the cause and locate the problematic code quickly. Bugs should always be reported to the Issue Tracker.

Before you report any bug:

  • Use the latest git version of pdf2htmlEX, since the issue may have been already fixed.
  • Search for previous issues (open or closed), to make sure that the issue has not been reported before.
  • If pdf2htmlEX crashed, take a look at this article.

A good bug report shouldn't leave others needing to chase you up for more information. The developers may be very familiar with the code base of pdf2htmlEX, but they may not know anything about your environment or what steps you have done, unless you have them stated. Please try to be as detailed as possible in your report. Good examples include: #58, #183 and #226.

If you are not sure, please try to answer the following questions:

  • What's your operating system?
  • What's the version of pdf2htmlEX and depended libraries? (You can post the output of pdf2htmlEX -v)
  • Which browser(s) are you using?
  • What steps will reproduce the issue? — please try to remove unnecessary steps
  • What's the result and what did you expect? — e.g. you can post screenshots
  • What error messages did you see?
  • Where's the affected PDF file and which pages are causing the issue? — e.g. you may upload the file via Dropbox and post a link here

Especially for issues regarding building pdf2htmlEX:

  • Which compiler are you using?
  • What's the output of cmake and make?
  • What's the content of CMakeList.txt?

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please read Using Pull Requests if you are new to pull requests.

IMPORTANT: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.