Like any open source project, RTeX depends on the participation of the community to keep it up to date, relevant, and as usable as possible.
Where?
The RTeX source is hosted on GitHub. Please contribute using GitHub if possible.
How to submit changes
Here’s the different ways you can send us changes (in descending order of desirability):
- Fork the project in GitHub and send a pull request
- Clone the project somewhere else, and ask us to pull your changes from your publically accessible URL
- Send us a git patch
- Send us a manual patch (please note originating commit) if you don’t use git
- Send us an email detailing your changes
- Scribble vague changes on a napkin and send COD
Get them accepted
To get your changes accepted as fast as possible, the following really help:
- Including a good reason for the change
- Including good tests (failing before, passing after)
- Making the code as backwards-compatible as possible
- Using generally accepted Ruby code conventions (yes, we know this is subjective)
- Including good documentation
Note we do accept documentation-only changes (even to this website, stored in site/ in the source!).