Restructure 'CONTRIBUTING.md' to show the different ways to contribute
more clearly, and to add a specific section about joining the
contributors' community.
[skip ci]
Signed-off-by: Michael Keller <mikeller@042.ch>
Add titles for the individual topics covered in CONTRIBUTING.md. One
advantage of this is that it makes it possible to link to individual
topics when providing feedback on pull requests.
Signed-off-by: Michael Keller <github@ike.ch>
File `CodingStyle` was renamed to `CodingStyle.md` in 0ceb7e01d (Convert
CodingStyle file to Markdown notations, 2018-04-14) and then to
`CODINGSTYLE.md` in 4ef1e9cb2 (documentation: coding style.,
2019-12-25). However, a link to the file in `CONTRIBUTING.md` wasn't
updated.
Fix the dead link to the coding style guidelines in `CONTRIBUTING.md`.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Git's own documentation consistency capitalizes the word "Git" in prose.
Follow its example and capitalize the word "Git" in prose of file
`CONTRIBUTING.md`.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Markdown doesn't have a syntax for image captions. While we could use
table syntax (an extension in GitHub's flavor of Markdown) to align the
caption more clearly with the image, it wouldn't be very readable in
plain text and Markdown renderers that don't have such an extension.
Reduce confusion of readers by makimg the caption of the gitk screenshot
formatted differently than the surrounding paragraphs. Use emphasis
syntax for that.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Replace hard-line break (rendered in HTML as a `<br />` tag) between two
paragraphs in `CONTRIBUTING.md` with an paragraph break (blank line) for
consistency with the rest of the document.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
List of code areas in `CONTRIBUTING.md` immediately follows the previous
line. While GitHub's Markdown parser doesn't mind, some Markdown
parsers don't consider it a list. Add a blank line between the list and
the preceding paragraph to ensure that the list is rendered correctly in
more Markdown renderers.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Wrap filenames in paragraphs in `CONTRIBUTING.md` in backticks to render
them in monospace font. Fix an accidental double space before the
reference to `CHANGELOG.md`, while we're here.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Replace double quotes around `git commit --amend` command example in
`CONTRIBUTING.md` with single backticks to format it in monospace font.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Use Markdown block syntax for the example of a commit message instead of
hard-line breaks with double spaces at the end. Such formatting
separates it from the other parts of the text in `CONTRIBUTING.md` and
makes the wrapping at 74 characters easier to understand with monospace
font. Do the same to the examples of `CHANGELOG.md` entries.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Replace combination of Markdown inline code syntax (single backticks)
and its hard-line break syntax (double space at end of the line) in file
`CONTRIBUTING.md` with block syntax (four-spaces-wide indentation) and
paragraph breaks (empty lines) for examples of commands to run to make
them look nicer and easier to read in plain text. Add a missing colon
before the `format-patch` example, while we're here.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Make `CONTRIBUTING.md` look a tiny bit nicer when rendered by replacing
double hyphens with en-dashes.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
Instead of using the Subsurface-divelog user on GitHub, we now use an org that
was generously donated to us.
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Removed the reference and link to the building page on the subsurface website
(https://subsurface-divelog.org/building) from CONTRIBUTIONG.md. This page no
longer exists and gives a 404 error. I have looked for suitable alternate
build/contributing instructions on the website and on github and can't find
anything so i think best to just remove the broken link for the time being. If
more comprehensive instructions exist in the future this will be simple to add
back in.
Signed-off-by: Jason Bramwell <jb2cool@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
The contribution instructions originally had the cd, git checkout and git pull
all on one command this is not allowed and gave a syntax/command error.
When I looked at the CONTRIBUTING.md file the commands were on three separate
lines it was just the markdown backticks that were missing from showing up as
three separate lines. I have simply wrapped each of these lines in its own
backticks.
Signed-off-by: Jason Bramwell <jb2cool@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Make it easier for new contributors to get going by making the
Signed-off-by line more clearly explained.
Signed-off-by: John Plaxco <john@johnplaxco.com>
Add section about string manipulation
Moved some of the existing conventions into the new section:
- variable declarations
- text strings
- UI text style
Update CONTRIBUTING.md with references to CodingStyle file
Signed-off-by: Jeremie Guichard <djebrest@gmail.com>
Add a note in CONTIRBUTING.md that imperative mood
is the preferred way to write commit messages.
Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
