Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.95 KB

contributing.md

File metadata and controls

63 lines (39 loc) · 2.95 KB

Contributing to Toltec

Thank you for taking 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 to fork this repository, make the desired changes in your newly created local copy, and open a pull request. When creating your pull request, make sure to target the testing branch instead of the default stable branch (PRs against the stable branch will not be merged).

When proposing 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

TODO

Reporting a Bug

TODO

Adding a New Package

See instructions for creating a package recipe.

  • clone this repository
  • switch to testing branch
  • edit package/$PACKAGE/package, making sure to bump the version
  • build the package (make $PACKAGE), making sure everything looks ok in artifacts/package/$PACKAGE/
  • install the package to your tablet, verifying things work as expected
  • for new packages, submit a pull request with the title: [$PACKAGE][$VERSION] - New Package
  • for updating packages, submit a pull request with the title: [$PACKAGE][$VERSION] - Updated Package

Upgrading a Package

TODO

Improving the Documentation

TODO

Style Guide

All contributions must follow the project’s style guide. Shell scripts must also comply to Shellcheck. 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.

The code style for shell scripts will automatically be checked when you submit your pull request. You may also check it manually by running make format (or make format-fix to automatically fix any issues) at the root of the repository (you need to have shfmt installed on your computer for this to work).

Compliance of shell scripts to Shellcheck will also automatically be checked. To check it manually, run make lint at the root of the repository (you need to have Shellcheck installed on your computer for this to work).

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.