Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 2.38 KB

contributing.rst

File metadata and controls

33 lines (26 loc) · 2.38 KB
Raw

How to update a certain method

The steps below clarify what you should think of when you update a certain method.

  1. Fork the GitHub repo.
  2. If you only change documentation and not code, you probably can just change and submit a pull request.
  3. If you change code, you can test your changes on Travis by copying the necessary files from the x-method-name folder to top level, changing the .travis.yml and pushing (to your fork).
  4. You should be able to view the Travis build for your fork on travis-ci.org.
  5. If it works, update the files in the x-method-name folder.
  6. If needed, update the documentation in the readme, including advantages/disadvantages at the beginning.
  7. Also update the test code for the method in the test/ folder.
  8. Revert the main .travis.yml file for this repo back to the state like it is on master, such that it runs all the tests.
  9. Push and check if the Travis build succeeds.
  10. If so, create a pull request - thanks for all the work!

How to add your own method

The steps below clarify what you should think of when you add your own method to build LaTeX on Travis (or possibly other CI services). You also might want to add it as an answer at tex.stackexchange.com.

  1. Fork the GitHub repo.
  2. Create a folder like x-method-name to put all the necessary files in like .travis.yml and possibly other files. This method may be inserted inbetween other methods, you can renumber them.
  3. Test your changes on Travis by copying the necessary files from the x-method-name folder to top level, changing the .travis.yml and pushing (to your fork). You can test compiling all LaTeX files present in the src/ folder, you also can of course create new test files.
  4. You should be able to view the Travis build for your fork on travis-ci.org.
  5. Add the documentation in the readme, including advantages/disadvantages at the beginning.
  6. Also add test code for the method in the test/ folder.
  7. Revert the main .travis.yml file for this repo back to the state like it is on master, such that it runs all the tests including the one you just created.
  8. Push and check if the Travis build succeeds.
  9. If so, create a pull request - thanks for all the work!