mirror of
https://github.com/mostlygeek/llama-swap.git
synced 2026-09-07 16:37:22 +02:00
Recently issues and pull requests are coming in at the same time. Updating the rules to clarify what is acceptable.
1.8 KiB
1.8 KiB
1. Contributing
The llama-swap project considers two types of contributing roles:
- Contributors are allowed to create issues, open pull requests and engage in discussion.
- Maintainers have contributor privileges and are also allowed to merge pull requests. Maintainers have an obligation to maintain the quality of the project.
2. Issues and pull requests
- Every pull request must reference an existing issue.
- ALWAYS open issues or pull requests yourself.
- ALWAYS write the descriptions yourself. You must understand your contribution well enough to be able to describe its value and the reasoning behind it.
- NEVER have an agent create issues and pull requests.
- NEVER create an issue because you already have a pull request just to satisfy the first rule.
- Maintainers may close issues or pull requests that look like slop.
3. Guidelines for humans and agents
- Good ideas, good designs and thoughtful requests are much more valuable contributions. Code is cheap now. The maintainers have coding agents too.
- AI written code is acceptable. AI written issues and pull requests are not.
- Search for existing issues or PRs before creating a new one. Adding feedback to existing discussions is preferred.
- Contributions must benefit most users. Do not submit PRs for niche or narrow features.
- Contributors must understand all code they submit. Perform a thorough review before submitting.
- New contributors are limited to one open PR at a time.
- Maintainers will squash and merge all PRs into the
mainbranch. - Write the PR description so it can be used as the squash commit message.
- Maintainers may ask you to squash your PR into a single commit before merging.
- Keep PRs small and focused. Change only the code necessary to fix the referenced issue. Maintainers will reject changes that are outside the issue discussion.