Skip to content

Commit e2e4d3d

Browse files
committed
CONTRIBUTING.md: add baselines and refer in README.md
Signed-off-by: Thierry Laurion <insurgo@riseup.net>
1 parent 1516320 commit e2e4d3d

2 files changed

Lines changed: 79 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
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!

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
![Heads booting on an x230](https://user-images.githubusercontent.com/827570/156627927-7239a936-e7b1-4ffb-9329-1c422dc70266.jpeg)
22

33
Heads: the other side of TAILS
4-
===
4+
==
55

66
Heads is a configuration for laptops and servers that tries to bring
77
more security to commodity hardware. Among its goals are:
@@ -25,28 +25,32 @@ Documentation
2525
===
2626
Please refer to [Heads-wiki](https://osresearch.net) for your Heads' documentation needs.
2727

28+
Contributing
29+
===
30+
We welcome contributions to the Heads project! Before contributing, please read our [Contributing Guidelines](CONTRIBUTING.md) for information on how to get started, submit issues, and propose changes.
31+
2832

2933
Building heads
30-
===
34+
==
3135

3236
Under QubesOS?
33-
====
37+
===
3438
* Setup nix persistent layer under QubesOS (Thanks @rapenne-s !)
3539
* https://dataswamp.org/~solene/2023-05-15-qubes-os-install-nix.html
3640
* Install docker under QubesOS (imperfect old article of mine. Better somewhere?)
3741
* https://gist.github.com/tlaurion/9113983bbdead492735c8438cd14d6cd
3842

3943
Build docker from nix develop layer locally
40-
====
44+
===
4145

4246
#### Set up Nix and flakes
4347

44-
* If you don't already have Nix, install it:
45-
* `[ -d /nix ] || sh <(curl -L https://nixos.org/nix/install) --no-daemon`
46-
* `. /home/user/.nix-profile/etc/profile.d/nix.sh`
47-
* Enable flake support in nix
48-
* `mkdir -p ~/.config/nix`
49-
* `echo 'experimental-features = nix-command flakes' >>~/.config/nix/nix.conf`
48+
* If you don't already have Nix, install it:
49+
* `[ -d /nix ] || sh <(curl -L https://nixos.org/nix/install) --no-daemon`
50+
* `. /home/user/.nix-profile/etc/profile.d/nix.sh`
51+
* Enable flake support in nix
52+
* `mkdir -p ~/.config/nix`
53+
* `echo 'experimental-features = nix-command flakes' >>~/.config/nix/nix.conf`
5054

5155

5256
#### Build image
@@ -74,7 +78,7 @@ Done!
7478
Your local docker image "linuxboot/heads:dev-env" is ready to use, reproducible for the specific Heads commit used and will produce ROMs reproducible for that Heads commit ID.
7579

7680
Jump into nix develop created docker image for interactive workflow
77-
=====
81+
====
7882
`docker run -e DISPLAY=$DISPLAY --network host --rm -ti -v $(pwd):$(pwd) -w $(pwd) linuxboot/heads:dev-env`
7983

8084

0 commit comments

Comments
 (0)