Skip to main content
This guide is a community effort. The more people who contribute, the better and more complete it becomes. Whether you’ve found a typo, have a suggestion for improvement, or want to add an entirely new section, your contributions are welcome!

Why Contribute?

Security is an ever-evolving field. What works today might not be sufficient tomorrow. By contributing, you help:

Keep it Current

Security best practices change as new threats emerge and tools evolve

Share Knowledge

Your experience and expertise can help others secure their servers

Fill Gaps

No single person knows everything - collaborative knowledge is stronger

Support the Community

Help fellow system administrators and security-conscious users

How to Contribute

This guide is hosted on GitHub, which makes collaboration easy. There are several ways you can contribute:

Option 1: Submit a Pull Request

For substantial contributions like new sections, improvements to existing content, or code corrections:
1

Fork the repository

Create your own copy of the repository on GitHub
2

Make your changes

Edit the files in your fork with your improvements
3

Test your changes

If possible, test any commands or configurations you’re adding
4

Submit a pull request

Open a PR from your fork back to the main repository with a clear description of your changes
Provide clear commit messages that explain what you changed and why. This helps maintainers review your contribution.

Option 2: Open an Issue

For bug reports, questions, suggestions, or if you’re not comfortable with Git:
1

Navigate to the issues page

2

Create a new issue

Click “New Issue” to open the issue form
3

Provide details

Include:
  • A clear, descriptive title
  • What you found or what you’re suggesting
  • Steps to reproduce (for bugs)
  • Your environment details (distro, version, etc.)
4

Submit and engage

Submit the issue and respond to any follow-up questions
Even if you’re not sure something is a bug or if your idea is good, open an issue anyway! Discussion helps improve the guide.

What to Contribute

Contributions can take many forms:

Content Improvements

  • New sections - Cover security topics not yet in the guide
  • Expanded explanations - Add more detail to existing sections
  • Updated information - Keep content current with latest best practices
  • Distribution-specific content - Add commands for other distros (RedHat, Arch, etc.)

Technical Updates

  • Tested configurations - Share working configs for specific use-cases
  • Code corrections - Fix errors in commands or scripts
  • New tools - Introduce security tools not currently covered
  • Alternative approaches - Suggest different ways to accomplish the same goal

Documentation Quality

  • Fix typos - Grammar, spelling, and formatting corrections
  • Clarify instructions - Make steps easier to follow
  • Add warnings - Note potential issues or gotchas
  • Better examples - Provide clearer or more relevant examples

References and Resources

  • Add references - Link to official documentation or authoritative sources
  • Cite best practices - Reference industry standards (CIS, NIST, etc.)
  • Link to related guides - Connect to complementary resources
Always ensure any external links you add are from reputable, authoritative sources. Avoid linking to potentially malicious or unreliable sites.

Contribution Guidelines

To ensure quality and consistency:

Technical Accuracy

If you’re adding commands or configurations:
  • Test them on a clean system when possible
  • Note which distribution(s) you tested on
  • Include any prerequisites or dependencies
  • Document any potential side effects
Match the guide’s structure and style:
  • Use the same section headings (Why, How It Works, Goals, Steps, etc.)
  • Maintain consistent code formatting
  • Follow the established tone (clear, practical, educational)
Don’t just show how to do something:
  • Explain why it’s important for security
  • Describe what threat or risk it addresses
  • Include context for when it should or shouldn’t be used

Content Quality

  • Use simple language when possible
  • Break complex topics into digestible chunks
  • Provide examples to illustrate concepts
  • Define technical terms when first used
  • Link to official documentation
  • Reference security standards or guidelines
  • Credit others’ work appropriately
  • Avoid making unsubstantiated claims
Remember that readers:
  • May be new to Linux server administration
  • Come from diverse technical backgrounds
  • Need practical, actionable guidance
  • Want to understand, not just copy-paste

Code and Commands

  • Provide working examples - All code should be tested and functional
  • Include comments - Explain what complex commands do
  • Show output - Include example output where helpful
  • Note variations - Document how commands differ across distributions
  • Backup first - Always include backup steps before destructive changes
Use code blocks with appropriate language tags (bash, python, etc.) for proper syntax highlighting.

What Makes a Good Contribution?

The best contributions:
  1. Solve a real problem - Address actual security concerns or usability issues
  2. Are well-explained - Provide context and reasoning, not just commands
  3. Are tested - Work as described and don’t break existing functionality
  4. Fit the guide’s scope - Focus on practical server security for at-home/small deployments
  5. Are accessible - Can be understood and implemented by the target audience
Don’t worry if your contribution isn’t perfect! Maintainers can help refine it through the review process.

Repository Information

By contributing, you agree that your contributions will be licensed under the same CC-BY-SA license as the rest of the guide.

Community Etiquette

When contributing:
  • Be respectful - Treat other contributors with courtesy
  • Be patient - Reviews take time, especially for large contributions
  • Be open to feedback - Maintainers may suggest changes to your contribution
  • Be collaborative - Work together to find the best solutions
If you’re making your first contribution, consider starting with something small like fixing a typo or improving an explanation. This helps you get familiar with the process!

Recognition

All contributors are valued members of the community. While there’s no formal rewards program, contributors:
  • Are credited in pull requests and commits
  • Help shape a resource used by thousands of people
  • Build their knowledge and skills
  • Give back to the open source community

Thank You!

Every contribution, no matter how small, makes this guide better. Your time and expertise help countless others secure their Linux servers.

Build docs developers (and LLMs) love