|
1 | 1 | # Contributing to Grout |
2 | 2 |
|
3 | | -First off, thank you for considering contributing to Grout! We appreciate your time and effort. |
4 | | - |
5 | | -Before implementing major features, please open an issue or discuss it in the |
6 | | -[Grout Development Channel](https://discord.com/channels/1138838206532554853/1456747141518069906) on the |
7 | | -[RomM Discord](https://discord.gg/P5HtHnhUDH) to ensure alignment with the project's direction. |
8 | | - |
9 | | -## Code of Conduct |
10 | | - |
11 | | -By contributing, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, constructive, and |
12 | | -welcoming to all contributors regardless of experience level. |
13 | | - |
14 | | -## Ways to Contribute (No Coding Required) |
15 | | - |
16 | | -Not a developer? There are many ways to help improve Grout! |
17 | | - |
18 | | -### Translations |
19 | | - |
20 | | -Help make Grout accessible to more users by translating it into your language. Translation files are located in `resources/locales/`. |
21 | | - |
22 | | -See the [Development Guide](/old_docs/DEVELOPMENT.md#internationalization-i18n) for details on the i18n workflow. |
23 | | - |
24 | | -### Testing & Bug Reports |
25 | | - |
26 | | -- Test Grout on your device and CFW combination |
27 | | -- Report bugs with detailed reproduction steps |
28 | | -- Verify fixes in pre-release builds |
29 | | -- Test edge cases (slow networks, large libraries, etc.) |
30 | | - |
31 | | -### Documentation |
32 | | - |
33 | | -- Fix typos and improve clarity in guides |
34 | | -- Write tutorials for specific use cases |
35 | | -- Add screenshots or animated demos |
36 | | -- Translate documentation |
37 | | - |
38 | | -### Platform Mapping Updates |
39 | | - |
40 | | -Help keep CFW platform directory mappings current: |
41 | | -- Report incorrect or missing platform mappings for your CFW |
42 | | -- Test new CFW releases and note any directory structure changes |
43 | | - |
44 | | -### Community Support |
45 | | - |
46 | | -- Help answer questions in the [RomM Discord](https://discord.gg/P5HtHnhUDH) |
47 | | -- Share tips and workflows with other users |
48 | | -- Welcome new community members |
49 | | - |
50 | | ---- |
51 | | - |
52 | | -## Getting Started (Developers) |
53 | | - |
54 | | -1. Read the [Development Guide](/old_docs/DEVELOPMENT.md) for setup instructions |
55 | | -2. Fork and clone the repository |
56 | | -3. Create a feature branch from `main` with a descriptive name (e.g., `feature/add-search-filter`) |
57 | | -4. Make your changes |
58 | | -5. Test locally on your target CFW if possible |
59 | | -6. Commit with clear, descriptive messages |
60 | | -7. Push and open a pull request against `main` |
61 | | - |
62 | | -## Pull Request Standards |
63 | | - |
64 | | -- Follow existing code conventions and patterns |
65 | | -- Test your changes locally before submitting |
66 | | -- Update documentation if your changes affect user-facing behavior |
67 | | -- Ensure the build passes (`task build` or `go build ./...`) |
68 | | -- Provide a clear description of what your PR does and why |
69 | | - |
70 | | -## Code Style |
71 | | - |
72 | | -We use standard Go formatting and conventions: |
73 | | - |
74 | | -- Run `go fmt` before committing |
75 | | -- Use `go vet` and `staticcheck` to catch issues |
76 | | -- Follow existing patterns in the codebase for consistency |
77 | | - |
78 | | -## Reporting Bugs |
79 | | - |
80 | | -Please [create an issue](https://github.com/rommapp/grout/issues/new/choose) with: |
81 | | - |
82 | | -- Your CFW and version (muOS, Knulli, Spruce, NextUI) |
83 | | -- Grout version |
84 | | -- Steps to reproduce the issue |
85 | | -- Expected vs actual behavior |
86 | | -- Any relevant logs or screenshots |
87 | | - |
88 | | -## License |
89 | | - |
90 | | -By contributing, you agree that your contributions will be licensed under the MIT License. |
| 3 | +For contribution guidelines, please see our documentation: https://grout.romm.app/development/ |
0 commit comments