Skip to content

Commit f4bffbb

Browse files
committed
docs: add MIT license and CONTRIBUTING guide
1 parent 734aa0a commit f4bffbb

2 files changed

Lines changed: 60 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing! Contributions are welcome in the form of bug reports, workflow improvements, new device support, and documentation fixes.
4+
5+
## Getting Started
6+
7+
1. **Fork** the repository and create a new branch from `main`:
8+
```bash
9+
git checkout -b feat/your-feature-name
10+
```
11+
2. Make your changes.
12+
3. Test the workflow by running it manually via the **Actions** tab on your fork.
13+
4. Open a **Pull Request** against `main` with a clear description of what you changed and why.
14+
15+
## What You Can Contribute
16+
17+
- 📱 **New device support** — add defconfig mappings and AnyKernel3 device entries for other Samsung devices
18+
- 🔧 **Workflow improvements** — faster build steps, better caching, toolchain upgrades
19+
- 🐛 **Bug fixes** — patches for build failures, Kconfig issues, or packaging problems
20+
- 📚 **Documentation** — clearer instructions, more device flash guides, translated READMEs
21+
22+
## Pull Request Guidelines
23+
24+
- Keep PRs focused — one change per PR
25+
- Use clear, descriptive commit messages (e.g. `fix: correct Mali Kconfig sed pattern`)
26+
- If adding a new device, include the device name, codename, and model number in the PR description
27+
- Ensure the workflow still passes on your fork before submitting
28+
29+
## Reporting Issues
30+
31+
If a build fails, please open an issue and attach:
32+
- The **compile log** artifact from the failed Actions run
33+
- The kernel source URL and branch you used
34+
- The KernelSU tag used
35+
- Your device model
36+
37+
## Code of Conduct
38+
39+
Be respectful. This is an open project and everyone is welcome regardless of experience level.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Justus Njagi
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)