Michael BiancoandGitHub
50761d3388
* refactor: clean up comments regarding version precedence - Remove redundant comments about "last write wins" and version precedence, as the implementation order is clear from the code. - Update the documentation for UseMiseVersions to clarify its role in the overwrite process. Generated-by: aiautocommit * docs: update contribution guidelines and add pull request template - Establish clear "Lifecycle of a Change" guide for developers - Formalize AI contribution policy and developer expectations - Add standard PR template to improve contribution quality and consistency - Refine documentation for local setup, testing, and workflow processes Generated-by: aiautocommit * docs: update contribution guidelines - Improve formatting of links and instructions. - Add instructions to run snapshot updates before finishing work. Generated-by: aiautocommit * feat: add retry-cli and apply to buildkit startup * Add retry-cli via mise to improve CI reliability. * Wrap the buildkit startup command with retry to mitigate transient connection or service availability issues during integration tests. Generated-by: aiautocommit * chore: replace retry-cli with local mise task * Remove external dependency `retry-cli` to reduce toolchain overhead. * Add a custom task script to handle command retries with exponential backoff directly within the project. * Enable `locked` mode in `mise.toml` to ensure consistent environment versions. Generated-by: aiautocommit * chore: disable mise lockfile enforcement * Commented out `locked` in `mise.toml` to allow for dependency updates without constant lockfile synchronization during development. Generated-by: aiautocommit
1.5 KiB
Contributing to Railpack
Pull Requests
We love contributions from the community! Please ensure your PRs:
- Address a specific problem or add a well-defined feature
- Include tests for new functionality
- Follow the existing code style
- Do not just make superficial changes (e.g., formatting, comments, version updated)
- PR title and description should follow the PR template
- Be concise when writing your PR description. Fine to use AI, but make sure to review and deslop any writing.
AI Policy
We love AI and encourage its use. However, in order to maintain a high-quality codebase and optimize the time of maintainers of the project, we have some guidelines around the use of AI in contributions:
-
DO NOT submit completely AI-generated PRs. If we suspect PRs is AI generated without careful human review, we will close them with a note indicating this (feel free to reopen if we got it wrong!). We use AI extensively in our development process, and it's easier for us to generate a PR from a well-written issue than it is review an AI generated PR with no human in the loop.
-
The human-in-the-loop must fully understand all code. A rule of thumb: if you can't explain what your changes do and how they interact with the greater system without the aid of AI tools, create a well-written GitHub issue instead so an engineer with a deeper understanding of the system can quickly generate a PR.