chore: add license and controbuting

This commit is contained in:
Aaron Yarborough 2025-02-19 22:57:15 +00:00
parent d891bb4287
commit cc6e22df9b

35
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,35 @@
# Contributing to This Project
Thanks for taking a look at my project! This is a personal hobby/side project I work on in my spare time. Its not designed with collaboration in mind, but Im happy to accept contributions if youd like to submit a pull request (PR)—I appreciate anyone willing to build on what I've done already!
## About This Project
As a side project, heres what you might encounter:
- **Documentation**: It could be minimal, rough, or outdated
- **Codebase**: Expect some rough edges—unpolished code, potential bugs, or bits that might need tweaking to run.
- **Maintenance**: Ill review issues and PRs as quickly as I can, though you may have to wait a little while until I can get to it
## How to Contribute
If youd like to contribute:
1. **Fork the Repository**: Make your own copy to work on.
2. **Make Changes**: Fix bugs, add features, or whatever you wish
3. **Test if You Can**: No big testing demands, but a quick check that it works is great.
4. **Submit a Pull Request**: Send a PR with a short note about your changes. Ill check it out when I can.
I dont usually enforce strict coding styles or commit rules (though some projects use git-commit hooks), and I may tweak things during merge to match as appropriate.
## Contribution Ideas
Im open to things like:
- Bug fixes or stability tweaks.
- New features or additions.
- Doc updates or code cleanup.
## Expectations
As a hobby, this project doesnt come with guarantees—PRs might not get merged right away, and not every issue will get a quick fix. If something sits for a while, its not personal, and youre welcome to keep building on your fork.
Thanks for considering a contribution!