Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 3.79 KB
Raw

Contributing to dndbook

First off, thank you for considering contributing to dndbook. It's people like you that make dndbook a great LaTeX package. There are many ways to contribute:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

We Develop on and Interact with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests. It is also where our community is hosted and where you can ask questions about dndbook through Github's issues.

As you interact with the community, please follow our Code of Conduct.

Have a Great Idea? Let Us Know

If you find yourself wishing for a feature that doesn't exist in dndbook, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that dndbook has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

Report Bugs Using Github's Issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Great Bug Reports tend to have:

  • A quick summary and/or background
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
  • A Minimum Working Example (MWE) that demonstrates the problem with the least amount of code.

Your MWE might be as simple as the following:

\documentclass[letterpaper,twocolumn,openany,nodeprecatedcode]{dndbook}

\begin{document}

% Code to demonstrate your problem.

\end{document}

If you have a problem that is not strictly dndbook specific, there are some other resources available. Overleaf has a good tutorial to get you up to speed with LaTeX, and tex.stackexchange.com is a great resource for getting help with other LaTeX packages.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

For small bug fixes, opening a Pull Request (PR) directly is okay, but larger changes and new functionality should be agreed on in an issue before development starts. Once it is time to get to work on a pull request:

  1. Fork the repo and create your branch from develop for new code or a version branch for bug fixes.
  2. Write your code.
  3. If you've changed the interface, update the documentation (example.tex).
  4. If you add a new package dependency, add the LaTeX package that contains it to packages.txt.
  5. Update CHANGELOG.md with any significant changes.
  6. Make sure your code lints. We use EditorConfig to enforce code styling.
  7. Issue that pull request!
  8. Ensure your PR passes the Continuous Integration (CI) tests.

After that, one of the maintainers will review your code and either accept it or request changes.

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to mention in the issue if that's a concern.