Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md: minor changes #788

Closed
wants to merge 2 commits into from
Closed

Conversation

WuerfelDev
Copy link
Contributor

@WuerfelDev WuerfelDev commented Jul 3, 2023

  • Misspelled GitHub
  • angle bracket not escaped correctly
  • Double white spaces
  • White spaces at EOL

- Misspelled GitHub
- angle bracket not escaped correctly
- Double white spaces
- White spaces at EOL
@jlduran
Copy link
Contributor

jlduran commented Jul 4, 2023

These are nice fixes, thank you!
Paging @bsdimp or @emaste.
The only thing I would suggest, is leaving the two spaces after the periods, maybe out of nostalgia, or maybe I could say that the CommonMark specification uses two spaces after periods.
It's up to them to decide.

@bsdimp
Copy link
Member

bsdimp commented Jul 4, 2023

Two spaces are the one true way.
Too many don't follow the way.
I can go either way, but I always use two spaces.

@WuerfelDev
Copy link
Contributor Author

I reinserted those spaces. Never used double spaces on purpose before but I guess it helps with readability

@igalic
Copy link
Contributor

igalic commented Jul 5, 2023

fwiw, in the docs and on the website, we ask people to put one sentence per line.
This makes it easy to read during review, and easy to diff on change, because changes often happen at a sentence level

@bsdimp
Copy link
Member

bsdimp commented Jul 5, 2023

fwiw, in the docs and on the website, we ask people to put one sentence per line. This makes it easy to read during review, and easy to diff on change, because changes often happen at a sentence level

I thought we didn't do that for markdown documents because it messed up the rendering

@jlduran
Copy link
Contributor

jlduran commented Jul 5, 2023

fwiw, in the docs and on the website, we ask people to put one sentence per line.
This makes it easy to read during review, and easy to diff on change, because changes often happen at a sentence level

Some Markdown (in GitHub's case CommonMark) parsers may interpret the the sentence on a new line as a line break.
For example, this sentence will appear on a new line, i.e., it will insert a <br> between the two lines, which is almost visually like a new paragraph, it may not be what I originally intended. I would have wanted it to look like this sentence.

If an empty line in between is used, then a paragraph is rendered.

@bsdimp
Copy link
Member

bsdimp commented Jul 7, 2023

OK. One last issue. The author name is listed as

Author: WuerfelDev <WuerfelDev@users.noreply.github.com>

which is a nonsense email address. Do you have a real email address you'd like me to use? or I could do Submitted by: github user WuerfelDev if you like.

@WuerfelDev
Copy link
Contributor Author

WuerfelDev commented Jul 7, 2023

OK. One last issue. The author name is listed as

Author: WuerfelDev <WuerfelDev@users.noreply.github.com>

which is a nonsense email address. Do you have a real email address you'd like me to use? or I could do Submitted by: github user WuerfelDev if you like.

Oh I even checked my git config and it had my normal email. Anyway you can use dev(at)wuerfeldev.de

@bsdimp
Copy link
Member

bsdimp commented Jul 7, 2023

Thanks! Pushed!
And at the last second, went ahead with the one space patch. I appreciate you reverting it, but I think that it's likely best to go with that trend.

@bsdimp bsdimp closed this Jul 7, 2023
@bsdimp bsdimp added the merged label Jul 7, 2023
freebsd-git pushed a commit that referenced this pull request Jul 7, 2023
- Misspelled GitHub
- angle bracket not escaped correctly
- Double white spaces
- White spaces at EOL

Reviewed by: imp
Pull Request: #788
freebsd-git pushed a commit that referenced this pull request Jul 10, 2023
Reviewed by: imp
Pull Request: #788
bsdjhb pushed a commit to bsdjhb/cheribsd that referenced this pull request Sep 2, 2023
- Misspelled GitHub
- angle bracket not escaped correctly
- Double white spaces
- White spaces at EOL

Reviewed by: imp
Pull Request: freebsd/freebsd-src#788
bsdjhb pushed a commit to bsdjhb/cheribsd that referenced this pull request Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants