Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 2.48 KB

Contributing to qubes-mgmt-salt-user

❤ Thank you for taking the time to contribute!

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose canges to this document in a pull request.

Code of Conduct

Let's start by the one rule: this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. No exceptions.

How can I contribute?

This project started as a way for me to learn about Saltstack and RPM packaging. The goal is to make common scenarios (like split-SSH, split-GPG) easier to setup and replicate in Qubes OS.

I find that using abundance of virtual machines is a great opportunity to learn more about configuration management and automation, and in turn configuration management allows me to better understand how all the moving pieces interact with each other in Qubes OS.

If you are currently learning about Salt, RPM packaging or Qubes OS, let's learn together! I probably misunderstood things, made mistakes and missed the mark on some trade-offs. If something seems odd, mistaken, or you simply cannot quite make sense of why I would have done it that way, please open a discussion! Chances are either I had a reason to do that and we can discuss it, or you found something I didn't! Either way, we'll likely learn something 🎉

  • Open a discussion to explain what you observe, and what you expect or don't understand
  • I'll comment there as soon as I can
  • We can find out together the next steps to improve on the code, or the documentation, or both! and open an issue to describe that
  • Once we have a clear idea of what we want to achieve, you can open a pull request if you want to
  • In the pull request, we can discuss together about how to solve the issue
  • Whether it is your first pull request or your 100th, I'm happy to give you a hand with the Git, GitHub or code details!
  • I'll finally ask you how you prefer to be given credit for your contribution, so we can include that in your pull request and merge it 🐿