CONTRIBUTING.md

Welcome to HamPi / HamPC contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on HamPi/HamPC Repository ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README and HamPi / HamPC Wiki. Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Getting started

To build an Ansible target with confidence, see Building HamPi from source 🎊.

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

1. Fork the repository.

• Using GitHub Desktop:

  • Getting started with GitHub Desktop will guide you through setting up Desktop.
  • Once Desktop is set up, you can use it to fork the repo!

• Using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

2. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.

Once your changes are ready, don't forget to self-review to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

• Don't forget to link PR to issue if you are solving one.
• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a HamPi / HamPC team member will review your proposal. We may ask questions or request for additional information.
• We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
• As you update your PR and apply changes, mark each conversation as resolved.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The HamPi / HamPC team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the HamPi/HamPC Repository.

Developers on Windows

This project can be developed on Windows, however one potential gotcha needs to be kept in mind:

1. Windows uses \r\n for line endings, while Unix based systems use \n. Being a Linux project, Windows developers shall use Unix EOL characters.