mirror of
https://github.com/iluvcapra/wavinfo.git
synced 2026-05-17 04:33:21 +00:00
48 lines
2.2 KiB
Markdown
48 lines
2.2 KiB
Markdown
# Contributing
|
|
|
|
Contributions to this project are very welcome!
|
|
|
|
If you discover a bug or would like better support for a feature, please do the following:
|
|
|
|
1. Submit an Issue.
|
|
|
|
I'm actively developing this project and will review incoming issues.
|
|
1. Check out the source code and submit a PR.
|
|
|
|
If you're facile with Python and understand what you'd like to fix, submit a PR and I'll
|
|
review it as soon as I can. There's a `.devcontainer` available so you can creates commits
|
|
on this project in a GitHub codespace.
|
|
|
|
|
|
## Regarding use of Agents
|
|
|
|
`wavinfo` is an open-source project that is offered free for no commerical gain, and
|
|
is developed and maintained for educational and creative reasons.
|
|
|
|
If you use an agent or LLM to produce code for it you are missing out on the benefits
|
|
of contributing to an open-source project, particularly community, collaboration with
|
|
other developers and designers, and being able to learn and experiment without the
|
|
burden of deadlines or worrying about business cases or profits.
|
|
|
|
This project is supposed to be fun, do not let machines have fun for you.
|
|
|
|
We can't prevent you from using LLMs to contribute to this project but we ask you
|
|
abide by the following eitiquette when doing so:
|
|
|
|
* All communication with the maintainers must be written by a human in their own
|
|
voice. Never use an LLM to craft thread comments, discussion posts, issues, emails
|
|
or other correspondence with other developers or the maintainers.
|
|
* PRs must be submitted by a person. Do not allow an agent to submit its own PRs to
|
|
this project.
|
|
* Especially if you are a new contributor to this project, please submit only one PR
|
|
at a time and please restrict the subject matter of the PR to a specific unit,
|
|
module or tool. All submissions have to be reviewed and understood by the
|
|
maintainers before they can be merged.
|
|
|
|
Obviously we can't verify if you follow all of these rules but certain telltale
|
|
traits of LLM-predicted text or code will raise a flag: lack of brevity in
|
|
descriptions or code comments, large amounts of text describing your process or
|
|
steps that add little to understanding the changes you've made, use of an
|
|
obsequious tone or being excessively accomodating, immediately doing requests
|
|
without further discussion or clarifications.
|