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.

Development Workflow

Checkout this guide.