diff options
| author | Eugene Triguba <hello@eugenetriguba.com> | 2026-02-08 18:22:53 -0500 |
|---|---|---|
| committer | Eugene Triguba <hello@eugenetriguba.com> | 2026-02-09 21:33:59 -0500 |
| commit | a6c9099cc2169179540e3196580c10d85823d307 (patch) | |
| tree | b1ce2d07609ff9dc3142bfec323b061bb3d84453 | |
| parent | Remove code of conduct (diff) | |
| download | lirc-a6c9099cc2169179540e3196580c10d85823d307.zip | |
Update contributing guide for contributing via sourcehut
| -rw-r--r-- | CONTRIBUTING.rst | 50 |
1 files changed, 3 insertions, 47 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f4eeb68..495b4ec 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -2,52 +2,8 @@ Contributing Guidelines ======================= Thank you for your interest! If you find a bug, want to suggest an improvement, or -any other change, please open a issue first. This ensures your time is not wasted -if you were planning on creating a pull request, but the changes suggested do not -work for this project. - -General Guidelines ------------------- - -Commit history: - -* Try to keep a clean commit history so it is easier to see your changes. - Keep functional changes and refactorings in separate commits. - -Commit messages: - -* Have a short one line summary of your change followed by as many paragraphs - of explanation as you need. This is the place to clarify any subtleties you - have in your implementation, document other approaches you tried that didn't - end up working, any limitations on your implementation, etc. The most important - part here is to describe why you made the change you did, not simply what the - change you made is. - -Changelog: - -* Please ensure to update the changelog by adding a new bullet under an Added, Changed, - Deprecated, Removed, Fixed, or Security section headers under the Unreleased version. - If any of those sections are not present, feel free to add the one you need. See - Keep a Changelog if you need guidance on what makes a good entry since this project - follows those principles. - -Tests: - -* Ensure the tests pass: ``poetry run task test`` to run all tests. - -* For any significant code changes, there must be tests to accompany them. - All unit tests are written with ``pytest``. - -Code Format: - -* There is a pre-commit pipeline to ensure a standard code format. - Make sure to install the pre-commit hooks before making any commits - with ``pre-commit install``. - -CI Pipeline: - -* There is a CI pipeline that is run using Github Actions on commits to master, dev, and on pull requests. - This pipeline must pass for your changes to be accepted. +just have a question, please send an email to ~eugenetriguba/public-inbox@lists.sr.ht +with a subject that starts with `[PATCH lirc]` for patches and `[lirc]` otherwise. Getting Up & Running -------------------- @@ -64,4 +20,4 @@ virtual environment. $ poetry shell From inside the virtual environment, we can work with the package and easily run the tasks for -this project such as ``task test`` and ``task lint`` that are in the ``pyproject.toml`` file.
\ No newline at end of file +this project such as ``task test`` and ``task lint`` that are in the ``pyproject.toml`` file. |