From a78291ff944a3ae2a6023bd88a7d7ff78739df5d Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Thu, 28 Aug 2025 08:10:09 -0500 Subject: [PATCH] Update CONTRIBUTING.md to be relevant to Hamlib --- CONTRIBUTING.md | 115 +++++++++++++++++++++++++++--------------------- 1 file changed, 66 insertions(+), 49 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7765fa2b7..4dc8b1725 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,18 @@ # Welcome to Hamlib docs contributing guide -Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:. +Thank you for investing your time in contributing to the Hamlib project! -Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. +Read our [Code of Conduct](./CODE_OF_CONDUCT.md) 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. +In this guide you will get an overview of the contribution workflow from +opening an issue, creating a PR, reviewing, and merging the PR. ## New contributor guide -To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions: +To get an overview of the project, read the [README](README.md) file. Here are +some GitHub resources to help you get started with Free Software/open source +contributions: - [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) - [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) @@ -20,74 +22,89 @@ To get an overview of the project, read the [README](../README.md) file. Here ar ## Getting started -To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)." +The [README.developer](README.developer) is a detailed overview of contributing +to the Hamlib project. -Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:. +For those primarily interested in testing, +[README.betatester](README.betatester) will serve as a guide. ### Issues #### Create a new issue -If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose). +If you wish to report a problem with a specific radio or have an idea for an +enhancement of Hamlib, take a look at the [Hamlib issue +tracker](https://github.com/Hamlib/Hamlib/issues). + +Use these GitHub documents to learn [how to search if an issue already +exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). +If a related issue doesn't exist, you can open a new issue using a relevant +[issue form](https://github.com/github/docs/issues/new/choose). + #### Solve an issue -Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. +Scan through our [existing issues](https://github.com/Hamlib/Hamlib/issues) to +find one that interests you. You can narrow down the search using `labels` as +filters. See "[Label +reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" +for more information. As a general rule, we don’t assign issues to anyone +unless interest is expressed in doing so as a signal it is being worked on. +If you find an issue to work on, you are welcome to open a PR with a fix and +reference the issue with the `#dddd` syntax in the text of your PR. This will +link the two. ### Make Changes -#### Make changes in the UI - -Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. - - - -#### Make changes in a codespace - -For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)." - #### Make changes locally 1. Fork the repository. -- Using GitHub Desktop: - - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-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](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! + - Using GitHub Desktop: + - [Getting started with GitHub + Desktop](https://docs.github.com/en/desktop/installing-and-configuring-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 Hamlib + repository](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop). -- Using the command line: - - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. + - Using the command line: + - [Fork the Hamlib + repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) + so that you can make your changes without affecting the original project + until you're ready to merge them. -2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](../contributing/development.md). - -3. Create a working branch and start with your changes! +2. Create a working branch and start with your changes! ### Commit your update -Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" to speed up the review process :zap:. +Commit the changes once you are satisfied with them and the code works as +intended + +**Note:** Some advice is out there to commit each time a file is saved. This +creates a needless string of commits that might never make it into the final +merge. Better is to test and iterate and once the code is where you want it +then commit with a descriptive message. Even so, it is worthwhile to use `git +rebase` to reorder, drop, squash, fixup, or one of the other actions it +provides to make you look like a code genius! ### Pull Request -When you're finished with the changes, create a pull request, also known as a PR. -- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. -- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. -- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. -Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information. -- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) 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](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). -- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. +After you've tested your commits to ensure they compile without errors, or +warnings (if possible), "push" your commits to your GitHub repository, i.e. +your *fork* of Hamlib. Once the push completes successfully the GitHub server +will return a URL that can be opened in your Web browser to create the Pull +Request (PR). + +### PR review + +Your PR will be reviewed by at least the Hamlib maintainer before being merged +into the master branch. Discussion may take place in the PR about one or more +commits and it's possible that the process will result in you being asked to +do something differently or consider another approach to solving a problem. +This is the process of collaborative development. ### Your PR is merged! Congratulations :tada::tada: The Hamlib team thanks you :sparkles:. -Once your PR is merged, your contributions will be publicly visible on [Hamlib](https://github.com/Hamlib/Hamlib). - -## Windows - -This site can be developed on Windows, however a few potential gotchas need to be kept in mind: - -1. Regular Expressions: Windows uses `\r\n` for line endings, while Unix-based systems use `\n`. Therefore, when working on Regular Expressions, use `\r?\n` instead of `\n` in order to support both environments. The Node.js [`os.EOL`](https://nodejs.org/api/os.html#os_os_eol) property can be used to get an OS-specific end-of-line marker. -2. Paths: Windows systems use `\` for the path separator, which would be returned by `path.join` and others. You could use `path.posix`, `path.posix.join` etc and the [slash](https://ghub.io/slash) module, if you need forward slashes - like for constructing URLs - or ensure your code works with either. -3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write [scripts](/script) in JavaScript instead of Bash. -4. Filename too long error: There is a 260 character limit for a filename when Git is compiled with `msys`. While the suggestions below are not guaranteed to work and could cause other issues, a few workarounds include: - - Update Git configuration: `git config --system core.longpaths true` - - Consider using a different Git client on Windows +Once your PR is merged, your contributions will be publicly visible on +[Hamlib](https://github.com/Hamlib/Hamlib).