|
| 1 | +# Contributing to Fallout Hacking Game |
| 2 | + |
| 3 | +First off, thanks for taking the time to contribute! 🎉 |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +## How Can I Contribute? |
| 8 | + |
| 9 | +### Reporting Bugs |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +Before creating bug reports, please check if the issue has already been reported. |
| 14 | + |
| 15 | +### Suggesting Enhancements |
| 16 | + |
| 17 | +This section guides you through submitting an enhancement suggestion for Fallout Hacking Game, including completely new features and minor improvements to existing functionality. |
| 18 | + |
| 19 | +### Pull Requests |
| 20 | + |
| 21 | +The process described here has several goals: |
| 22 | + |
| 23 | +- Maintain Fallout Hacking Game's quality |
| 24 | +- It's a simple shell game and I want to keep it playable from shell |
| 25 | + |
| 26 | +Please follow these steps to have your contribution considered by the maintainers: |
| 27 | + |
| 28 | +1. Fork the repository and create your branch from `main`. |
| 29 | +2. If you've added code that should be tested, add tests. |
| 30 | +3. If you've changed APIs, update the documentation. |
| 31 | +4. Ensure the test suite passes. |
| 32 | +5. Make sure your code lints. |
| 33 | +6. Issue that pull request! |
| 34 | + |
| 35 | +### Coding Style |
| 36 | + |
| 37 | +- Follow the PEP 8 style guide for Python code. |
| 38 | +- Use meaningful variable and function names. |
| 39 | +- Write clear and concise comments. |
| 40 | + |
| 41 | +### Documentation |
| 42 | + |
| 43 | +Documentation is crucial for any project. If you are adding new features or changing existing ones, please update the documentation accordingly. |
| 44 | + |
| 45 | +## Code of Conduct |
| 46 | + |
| 47 | +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. |
| 48 | + |
| 49 | +## License |
| 50 | + |
| 51 | +By contributing, you agree that your contributions will be licensed under the MIT License. |
| 52 | + |
| 53 | +Thank you for contributing! |
0 commit comments