|
| 1 | +# Contributing to Mod Installer |
| 2 | + |
| 3 | +First off, thank you for considering contributing to Mod Installer. It's people like you that make Mod Installer such a great tool. |
| 4 | + |
| 5 | +## Code of Conduct |
| 6 | + |
| 7 | +By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [PROJECT MAINTAINER EMAIL]. |
| 8 | + |
| 9 | +## How Can I Contribute? |
| 10 | + |
| 11 | +### Reporting Bugs |
| 12 | + |
| 13 | +This section guides you through submitting a bug report for Mod Installer. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. |
| 14 | + |
| 15 | +- Use a clear and descriptive title for the issue to identify the problem. |
| 16 | +- Describe the exact steps which reproduce the problem in as many details as possible. |
| 17 | +- Provide specific examples to demonstrate the steps. |
| 18 | + |
| 19 | +### Suggesting Enhancements |
| 20 | + |
| 21 | +This section guides you through submitting an enhancement suggestion for Mod Installer, including completely new features and minor improvements to existing functionality. |
| 22 | + |
| 23 | +- Use a clear and descriptive title for the issue to identify the suggestion. |
| 24 | +- Provide a step-by-step description of the suggested enhancement in as many details as possible. |
| 25 | +- Provide specific examples to demonstrate the steps. |
| 26 | + |
| 27 | +### Pull Requests |
| 28 | + |
| 29 | +- Fill in the required template |
| 30 | +- Do not include issue numbers in the PR title |
| 31 | +- Include screenshots and animated GIFs in your pull request whenever possible. |
| 32 | +- Follow the Rust styleguides. |
| 33 | +- Include thoughtfully-worded, well-structured tests. |
| 34 | +- Document new code based on the Documentation Styleguide |
| 35 | +- End all files with a newline |
| 36 | + |
| 37 | +## Styleguides |
| 38 | + |
| 39 | +### Git Commit Messages |
| 40 | + |
| 41 | +- Use the present tense ("Add feature" not "Added feature") |
| 42 | +- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") |
| 43 | +- Limit the first line to 72 characters or less |
| 44 | +- Reference issues and pull requests liberally after the first line |
| 45 | +- Consider starting the commit message with an applicable emoji: |
| 46 | + - 🎨 `:art:` when improving the format/structure of the code |
| 47 | + - 🐎 `:racehorse:` when improving performance |
| 48 | + - 🚱 `:non-potable_water:` when plugging memory leaks |
| 49 | + - 📝 `:memo:` when writing docs |
| 50 | + - 🐧 `:penguin:` when fixing something on Linux |
| 51 | + - 🍎 `:apple:` when fixing something on macOS |
| 52 | + - 🏁 `:checkered_flag:` when fixing something on Windows |
| 53 | + - 🐛 `:bug:` when fixing a bug |
| 54 | + - 🔥 `:fire:` when removing code or files |
| 55 | + - 💚 `:green_heart:` when fixing the CI build |
| 56 | + - ✅ `:white_check_mark:` when adding tests |
| 57 | + - 🔒 `:lock:` when dealing with security |
| 58 | + - ⬆️ `:arrow_up:` when upgrading dependencies |
| 59 | + - ⬇️ `:arrow_down:` when downgrading dependencies |
| 60 | + |
| 61 | +### Rust Styleguide |
| 62 | + |
| 63 | +All Rust code should adhere to [Rust Style](https://doc.rust-lang.org/beta/style-guide/index.html) and be formatted using `cargo fmt`. |
| 64 | + |
| 65 | +## Additional Notes |
| 66 | + |
| 67 | +### Issue and Pull Request Labels |
| 68 | + |
| 69 | +This section lists the labels we use to help us track and manage issues and pull requests. |
| 70 | + |
| 71 | +* `bug` - Issues that are bugs. |
| 72 | +* `enhancement` - Issues that are feature requests. |
| 73 | +* `documentation` - Issues or pull requests related to documentation. |
| 74 | +* `good first issue` - Good for newcomers. |
| 75 | + |
| 76 | +### Thank you! |
| 77 | + |
| 78 | +Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute. |
0 commit comments