Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

90 lines (65 loc) · 3.47 KB
Raw

CONTRIBUTING

If you find an issue that interests you, please leave a note asking about it first. If you don't see that anyone has inquired about it, you can simply leave a note saying you are going to work on it. If people work on an issue without saying they are working on it, the result is sometimes three people submit a PR for the same issue.

If you find a problem for which no ticket has yet been created, please don't hesitate to open a new ticket, and let us know if you are going to work on that issue.

Please leave another note if you change your mind or if you get busy with other things and are unable to finish it. That lets me and other people know the ticket is available to be worked on by other people.

Coding style

The goal is GNU style formatting

Sometimes a patch will be a single line in a single file; other times a single from each other (i.e. a separate PR for each patch).

Web site

Most of the files for the web site are in docs/infiles and can be changed with a pull request through GitHub. To preview your changes, you can use docs/src/simplecgen to generate new html files in docs/

Thank you!

Pull Requests

  1. Join the #hldig channel on Libera IRC, so if any problems arise, you can get support.

  2. Fork the repo (if you haven't already done so)

  3. Clone it to your computer

  4. When you're ready to work on an issue, be sure you're on the master branch. From there, create a separate branch (e.g. issue_32)

  5. Make your changes. If you're unsure of some details while you're making edits, you can discuss them on the ticket.

  6. If you are a first time contributor, please add your name and link of your choice to AUTHORS.md.

  7. Commit your changes. git-cola is a nice GUI front-end for adding files and entering commit messages (git-cola is probably available from your OS repository).

  8. Push the working branch (e.g. issue_32) to your remote fork and make your pull request.

    • Do not merge it with the master branch on your fork. That would result in multiple, or unrelated patches being included in a single PR.

  9. If any further changes need to be made, comments will be made on the pull request.

It's possible to work on two or more different patches (and therefore multiple branches) at one time, but it's recommended that beginners only work on one patch at a time.

Syncing

Periodically, especially before starting a new patch, you'll need the sync your repo with the remote upstream. GitHub has instructions for doing this:

  1. Configuring a remote for a fork

  2. Syncing a Fork

    • On that page, it shows how to merge the master branch (steps 4 & 5 of Syncing a Fork).