The PCGen project uses a system named
JIRA
, located at
jira.pcgen.org
, to track bug reports and feature requests (
issues
).
This page explains how to submit bug reports or feature requests for the PCGen project.
Note: JIRA has replaced the previous issue tracker at SourceForge, which is no longer used.
Search JIRA to see if your issue has already been discussed.
Searching in JIRA.
You can enter search terms (i.e. bardic music ) in the search box at the top right-hand side of the screen. A list of issues matching your search terms will be shown. Check this list to see if your issue has already been discussed.
If your issue has already been discussed, you should consider adding a comment to the existing issue, instead of filing a duplicate issue.
Sign up for JIRA and log in. (See: Account creation and log-in .)
Click the Create Issue button at the top of the screen.
The Create Issue button.
Fill in the Create Issue form.
The first half of the Create Issue form.
The Description should include as much detail as required to fully explain your issue.
If you are experiencing a bug, then describe:If you are requesting a feature, then include enough detail to specify what it is you want added.
The second half of the Create Issue form.
Once the issue is created, the project team will be notified there is a new issue for their attention.
You will be notified via email if the project team needs any more information, and when the issue is resolved.
An example of a submitted issue is shown below.
An account is required to participate in the JIRA issue tracker. The sign-up link is on the JIRA front page :
The sign-up link on the front page.
Once you have completed the sign-up process, you can log in:
The log-in screen.
The JIRA system contains several "sub-projects", representing parts of the overall PCGen project.
The sub-projects displayed on the JIRA front page.
The sub-projects are as listed below.
Filing your issue under the right sub-project helps members of the development team to keep track of their part of the project. If in doubt, pick the sub-project you think is the closest match for your issue; someone will fix it up afterwards, if required.
CODE
: PCGen program including the user interface, parsing of data, rules engine, output tags etc.
DATA
: LST/Data issues and requests.
DOCS
: The user manual, which you are reading now.
NEWSOURCE
: This is where new books are entered that have permission to be included in PCGen.
NEWTAG
:
(Ed: What is this?)
OS
: Output sheets.
PLAYTEST
: Non-versioned sets.
(Ed: What is this for?)
PRET
: The
prettylst.pl
Perl program, used to pretty-print
LST
files and update them to the latest tag formats.
HELP
: For general user support requests, such as
"How do I?..."
Note this is one of many places you can get help. Other places you can get help include:
pcgen
mailing list. (Old; being phased out.)
When reporting issues, you should include:
Your PCGen version and Java version can be found by opening the Help > About dialog in PCGen.
The Help > About... dialog.