2.3 KiB
Contributing
We love pull requests from everyone. By participating in this project, you agree to abide by our code of conduct.
Fork, then clone the repo:
git clone git@github.com:your-username/manyfold.git
Get the app running locally by following these instructions:
Then make sure the tests pass:
rake
Make your change. Add tests for your change. Make sure the old and new tests both pass!
Push to your fork and submit a pull request.
We try to at least comment on pull requests within a few days (and normally much quicker). We may suggest some changes, improvements, or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Sign our simple Contributor License Agreement agreeing to license your code as MIT
- Write tests.
- Check that your code passes our linter.
- Write a good commit message.
Generative AI policy
We are highly unlikely to review or accept AI-generated or "vibe coded" PRs; our time is very limited, and we need to know that you understand exactly what the code is doing and why, so that we can review it effectively with you.
In addition, AI-generated code is likely incompatible with our license and CLA, as the author cannot guarantee that it does not reproduce copyrighted or FOSS-incompatible material. See the NLNet generative AI policy for more explanation of this and how it could even jeopardise our funding.
If you really must submit AI-generated code, you will need to include prompt provenance including the model used, dates and full content of prompts, and the unedited LLM output. Again, see the NLNet generative AI policy, and the article Track Prompt Provenance in Version Control by Pablo Santos Luaces.