Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 4.25 KB

contributing.md

File metadata and controls

72 lines (49 loc) · 4.25 KB
Raw

Contributing to Toltec

Thank you for taking the time to contribute to Toltec! We welcome contributions from anyone, regarding for example reporting bugs, requesting or adding new packages, upgrading existing ones, improving the docs, or other topics.

To make a request or report a bug, you simply need to open a new issue. To directly propose changes, the basic procedure is:

  1. Fork this repository.
  2. Create a new branch off the testing branch.
    This is important! PRs against the default stable branch won’t be merged.
  3. Make the desired changes in your newly created local copy.
  4. Open a pull request.

When making your changes, please make sure that you follow the style guide. After you submit your pull request, a maintainer will take time to review your changes, request modifications, and then merge your changes into the repository if they fit.

Common Contributions

Requesting a Package

If you would like to see a project packaged in Toltec, you can open an issue to request its addition. Note that only free software can be added to the repository. Please give at least the following information in your request:

  • Where can information about this project be found on the Internet?
  • What license is it available under?
  • What is it useful for? Describe some use cases.

Your request will be considered by other contributors based on the usefulness of the package and the work required to create and maintain it. If you’re unsure whether a package is suitable for inclusion in Toltec, you can always drop by the reMarkable Discord server to ask others about it.

Reporting a Bug

Found a bug in one of the packages or the install scripts? To help us fix this, please open an issue and give us as much information as possible:

  • What device are you using (reMarkable 1 or reMarkable 2)?
  • What mods/hacks/additional software did you install on your device?
  • If possible, describe a sequence of steps by which the bug can be reproduced.
  • Otherwise, at least describe the context under which the bug occurred.

Please don’t use the issues to ask for help with your device. Refer to the reMarkable Discord server to ask for assistance instead. If the bug originates from packaged software itself, it might be more appropriate to report it to the original project.

Adding a New Package

The quickest way to add a new package to Toltec is to write the recipe that describes how that package is built then to propose it through a pull request. See the guide on how to write a recipe. Before proposing your package, make sure that it conforms to the rules on how to structure a recipe.

Style Guide

Sticking to a common set of conventions makes it easier for everyone to read the source code and reduces the time spent reviewing little formatting details.

All contributions must follow the project’s style guide. The code style for shell scripts and Python code will automatically be checked for pull requests and can be checked locally using make format. Use make format-fix to automatically reformat your code to fit the style guide.

Shell scripts must comply with Shellcheck. Python code must have valid type annotations (typechecked using mypy) and be free of pylint errors. Compliance with those tools will automatically be checked for pull requests and can be checked locally using make lint.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

License

By contributing to Toltec, you agree to place your contributions under the MIT license.