|
| 1 | +# Contributing to LinuxBoot/Heads |
| 2 | + |
| 3 | +Thank you for your interest in contributing to LinuxBoot/Heads! We welcome contributions |
| 4 | +from everyone. By participating in this project, respecting these contribution guidelines |
| 5 | +will ease and fasten their review, fixing and merging. |
| 6 | + |
| 7 | +## Communication Channels |
| 8 | + |
| 9 | +For the most up-to-date information on our community channels, please visit: |
| 10 | +https://osresearch.net/community/ |
| 11 | + |
| 12 | +## Best Practices for Issues and Contributions |
| 13 | + |
| 14 | +Before opening an issue or submitting a contribution, please: |
| 15 | + |
| 16 | +1. Search existing resources (GitHub issues, wiki, Matrix channel history). |
| 17 | +2. Review the documentation at https://osresearch.net. |
| 18 | +3. Choose the appropriate channel for your contribution or question. |
| 19 | + |
| 20 | +### When Starting a Discussion on Matrix |
| 21 | + |
| 22 | +- Clearly state your topic or question. |
| 23 | +- Provide context, including your environment (OS, hardware, etc.) if relevant. |
| 24 | +- Be patient and respectful while waiting for responses. |
| 25 | +- Structure your topic effectively with a clear title and organized content. |
| 26 | +- Use code blocks for command outputs or error messages. |
| 27 | +- Consider breaking complex topics into smaller, manageable questions. |
| 28 | +- Tag your topic with relevant keywords. |
| 29 | + |
| 30 | +### When Opening an Issue on GitHub |
| 31 | +- Search globally on linuxboot organization for related keywords first. |
| 32 | + - EG: yubikey search in issues: https://github.com/search?q=org%3Alinuxboot+yubikey&type=issues |
| 33 | +- Choose a clear and descriptive title. |
| 34 | +- Clearly describe the problem or suggestion: |
| 35 | + - Summarize the issue or feature request. |
| 36 | + - Explain current behavior and expected behavior. |
| 37 | + - For bugs, provide steps to reproduce. |
| 38 | + - For feature requests, explain use case and benefits. |
| 39 | +- Mention your environment details. |
| 40 | +- If you have a proposed solution, describe it briefly. |
| 41 | +- Check for related issues or pull requests and link them. |
| 42 | +- Format your issue for readability using Markdown. |
| 43 | + - Here is a nice advanced online editor alternative to GitHub: https://stackedit.io/app# |
| 44 | +- Be responsive to follow-up questions. |
| 45 | + |
| 46 | +### For Pull Requests |
| 47 | + |
| 48 | +- Link to related issues or discussions. |
| 49 | +- Provide a clear description of the changes and their purpose. |
| 50 | +- Be responsive to feedback and prepared to make adjustments. |
| 51 | +- **Important**: All commits to linuxboot/heads (*not heads-wiki!*) must be signed. For instructions, see: |
| 52 | + [Signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) |
| 53 | + |
| 54 | +## GitHub Repositories |
| 55 | + |
| 56 | +- **linuxboot/heads**: https://github.com/linuxboot/heads |
| 57 | + - Main repository for code, development, and user experience improvements. |
| 58 | + - All commits must be signed. |
| 59 | +- **linuxboot/heads-wiki**: https://github.com/linuxboot/heads-wiki |
| 60 | + - Repository for project documentation. |
| 61 | + - Content is rendered and searchable at https://osresearch.net |
| 62 | + - *Commits don't have to be signed to lower bar for contribution*. |
| 63 | + |
| 64 | +We appreciate your contributions to the LinuxBoot/Heads project! |
0 commit comments