Thanks for considering contributing to this project, it would be amazing if that happened, and I’d be stoked to have your help! Here are a few guidelines to help smooth out this process and to get your changes into Clipetty ASAP.
Fork the project on Github, commit your changes to your fork’s master branch, and then submit a Pull Request. I’ll take a look, and we’ll have a conversation about your proposed changes in the PR. This is how most projects on Github work, and this one is no different.
If your PR contains a non-trivial change or fixes a bug that the unit tests didn’t catch, it’d be great if you were to add one or more unit tests to clipetty-test.el.
The script run-tests.sh is used by the CI workflow to make sure commits to master or new pull requests pass all the existing tests, including:
- Ensuring the elisp byte-compiles cleanly
- Ensuring that
M-x checkdocis happy - Ensuring that package-lint is happy
- Ensuring that all the existing unit tests still pass
Some of these tests can be picky and annoying. My advice is to just make the
linter happy and move on. You should probably run run-tests.sh manually yourself
before submitting your PR so there aren’t any surprises.
The README.md file is generated from README.org using
org-gfm-export-to-markdown, so if you’d like to suggest a change to the
documentation, make sure to commit your change to the right place.