First off, thanks for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to Fallout Hacking Game. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This section guides you through submitting a bug report for Fallout Hacking Game. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please check if the issue has already been reported.
This section guides you through submitting an enhancement suggestion for Fallout Hacking Game, including completely new features and minor improvements to existing functionality.
The process described here has several goals:
- Maintain Fallout Hacking Game's quality
- It's a simple shell game and I want to keep it playable from shell
Please follow these steps to have your contribution considered by the maintainers:
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- Follow the PEP 8 style guide for Python code.
- Use meaningful variable and function names.
- Write clear and concise comments.
Documentation is crucial for any project. If you are adding new features or changing existing ones, please update the documentation accordingly.
This project and everyone participating in it is governed by the Fallout Hacking Game Code of Conduct. By participating, you are expected to uphold this code.
By contributing, you agree that your contributions will be licensed under the MIT License.
Thank you for contributing!