Thank you for considering contributing to PackShip! This document outlines the process for contributing to the project.
By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.
- Check if the bug has already been reported in the Issues section
- Use the bug report template when creating a new issue
- Follow our Issue Naming Convention
- Include detailed steps to reproduce the bug
- Include information about your environment (OS, Node.js version, etc.)
- Check if the feature has already been suggested in the Issues section
- Use the feature request template when creating a new issue
- Follow our Issue Naming Convention
- Explain why this feature would be useful to most users
- Fork the repository
- Create a new branch for your changes following our Branch Naming Convention
- Make your changes
- Run tests to ensure your changes don't break existing functionality
- Submit a pull request
- Clone the repository
- Install dependencies with
npm install - Build the project with
npm run build - Run the CLI with
npm start
- Use TypeScript for all new code
- Follow the existing code style
- Use descriptive variable names
- Add comments for complex logic
- Write tests for new features
- Follow the Conventional Commits specification
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Add tests for new features
- Ensure all tests pass before submitting a pull request
- Run tests with
npm test
By contributing to PackShip, you agree that your contributions will be licensed under the project's MIT license.