We welcome contributions to the DITA-OT.
If you find a bug — and you don’t know how to fix it, create an issue to request changes.
Before you do that, review the open issues to make sure it hasn't already been reported.
A good issue description contains:
- description of the problem,
- copy of the error message and/or stack trace,
- version of DITA-OT, and
- a self-contained test case.
A test case is simply a set of files that can be used to reproduce the issue. Gist is an easy way to upload your test files and link them to the issue description; github also allows you to create a zip of test files and attach those to the issue.
or — even better:
If you know how to fix the issue yourself, that's great! Here's what to do:
- Fork the repository,
- Create a new branch,
- Make your changes on the new branch, and
- Send a pull request.
The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Then you just add a line to every Git commit message:
Signed-off-by: Jane Doe <[email protected]>
Use your real name (sorry, no pseudonyms or anonymous contributions.)
If you set your user.name and user.email Git configs, you can sign your commit automatically with git commit -s.
The DITA-OT project uses the Git Flow branching strategy.
In this model, change requests are tracked in feature branches that are created by branching off of the main development baseline in the develop branch. This makes it easier to keep track of related changes and merge them back into the development stream later. To find out more about how this works, see the Gitflow Workflow tutorial.
To send a pull request, create a feature branch in your fork with a name like feature/my-changes, make your changes on that branch in your fork and issue the pull request from there.
Note: By default, pull requests are based on the develop branch of the parent dita-ot repository, which is appropriate for feature enhancement pull requests. When you create a pull request, GitHub allows you to change the base branch if you think your changes should be applied to a different branch. To fix a bug in the current release, set the base branch for your pull request to the hotfix/ branch for the latest stable version.
For more information, see Contributing to Open Source on GitHub.