Contributing Guidelines

Thank you for your interest in contributing to EngineHub projects! We appreciate your effort and contribution, but to make sure that the inclusion of your PR is a smooth process, we ask that you make note of the following guidelines. Individual projects may have additional requirements and style guidelines, so make sure to check the contributing guide in the project repository before submitting a change.

Contributing

  • Make sure the code is efficient. One way you can achieve this is to spend around ten minutes to think about what the code is doing and whether it seems awfully roundabout. If you had to copy the same large piece of code in several places, that's bad.
  • Test your code. We're not interested in broken code, for the obvious reasons.
  • Write tests. While this is optional, we recommend it for complicated algorithms and are trying to improve our overall test code coverage.
  • Understand your contributions. We have a base expectation that you have read the code you are contributing, and understand what it's doing. We ask that you please respect that people will be reviewing your code, and that you have proofread it and understand it before submitting.
  • No non-human co-authors. While we do not have a hard rule against AI-assisted development, we ask that all code is vetted by a human contributor before submission. Including a non-human co-author implies a level of vetting far below what we expect.
  • Write clear prose. Ensure your writing in all parts of the PR is clear. This includes the title, description, commit messages, code documentation, and comments. Text that is obviously AI-generated should not be present, and may result in only partial reviews until it is cleaned up.

Checklist

Ready to submit? Perform the checklist below:

  1. Have I git rebase'd my pull request to the latest commit of the target branch?
  2. Have I combined my commits into a reasonably small number (if not one) commit using git rebase?
  3. Have I made my pull request too large? Pull requests should introduce small sets of changes at a time. Major changes should be discussed with the team prior to starting work.
  4. Are my commit messages descriptive?
  5. Keep commit summaries under 70 characters. For more details, place two new lines after the summary line and write away!
  6. AI Disclosure. Beyond a certain point, we require that you disclose the level of AI involvement as part of your pull request description. If the committed code in your PR is more than 50% directly written by AI, you should disclose your best estimate of that percentage. PRs that are more than 90% AI generated and that contain a significant amount of changes have a higher chance of being rejected, as it may make it difficult for us to review.

You should be aware of git rebase. It allows you to modify existing commit messages, and combine, break apart, or adjust past changes.