Contributing
Thank you for your interest in contributing to Cover-Letter-LLM! We welcome contributions from the community. Please follow these guidelines to help us maintain a high-quality project.
Table of Contents
Getting Started
Before you begin, please ensure you have reviewed the main README.md for an overview of the project and its technology stack.
For detailed setup instructions, example commands for generating components, initial code structures, and a walkthrough of the core implementation steps, please refer to our Full-Stack Implementation Guide. This guide contains valuable context from the initial project plan.
- Fork this repository and clone your fork locally.
- Set up the project by following the instructions in the Setup & Installation section of the README.
Branching & Workflow
- Create a new branch for each feature or bugfix (e.g.,
feature/your-feature-name or bugfix/issue-description).
- Make sure your branch is up to date with the latest changes from
main before submitting a pull request.
Coding Standards
- Follow the Ruby and Rails community style guides.
- Run
rubocop -a to automatically fix style issues before committing.
- Write and update tests for your changes. All tests must pass before your PR will be reviewed.
Submitting Changes
- Open an issue to discuss your proposed change before submitting a pull request, especially for large changes.
- Submit a pull request with a clear description of your changes and reference any related issues.
- Ensure your pull request passes all CI checks.
Code of Conduct
- Please be respectful and considerate in all interactions.
- For questions, open an issue or contact the project maintainers via GitHub.
- For full contribution guidelines, see this document and the README.md.