Thank you for your interest in contributing to Penny Pilot! This document provides guidelines and steps for contributing to the project.
- Fork the repository
- Clone your fork:
git clone https://github.com/sesartrumpet/cs386-pennypilot.git - Create a new branch:
git checkout -b branchName
- Follow the installation instructions in the README.md for your operating system (Mac/Windows)
- Make sure all tests pass before making changes
- Add new tests for new functionality
- Write clear, concise commit messages
- Follow the existing code style and conventions
- Document any new functions, classes, or modules
- Update README.md if you're adding new features or changing functionality
- Push your changes to your fork
- Submit a Pull Request (PR) to the main repository
- In your PR description:
- Describe the changes you've made
- Reference any related issues
- Mention any breaking changes
- Include screenshots for UI changes
- At least one other developer must review and approve your PR
- All tests must pass
- Documentation must be updated if necessary
- Code style guidelines must be followed
When reporting issues, please include:
- A clear description of the problem
- Steps to reproduce the issue
- Expected vs actual behavior
- Your operating system and relevant software versions
- Screenshots if applicable
Feel free to:
- Open an issue for questions
- Contact the project maintainers
- Join our development discussions
- Use consistent indentation (spaces, not tabs)
- Follow PEP 8 for Python code
- Keep functions and methods focused and small
- Write descriptive variable and function names
For the complete code of conduct, please see CODE_OF_CONDUCT.md.