Skip to content

Expand contributing guidelines - #1154

Draft
Kalobi wants to merge 2 commits into
EverestAPI:devfrom
Kalobi:contributing
Draft

Expand contributing guidelines#1154
Kalobi wants to merge 2 commits into
EverestAPI:devfrom
Kalobi:contributing

Conversation

@Kalobi

@Kalobi Kalobi commented Aug 3, 2026

Copy link
Copy Markdown
Member

Add some points that have recently come up to the contributing guidelines. Suggestions welcome.

@maddie480-bot maddie480-bot added the 0: draft This PR is not ready for review yet (bot-managed) label Aug 3, 2026

@SnipUndercover SnipUndercover left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving this from #modding_dev to here to keep a paper trail.
Markdown has significant trailing whitespace; putting two or more whitespaces at the end of a line inserts a line break (HTML <br/>), as opposed to two blank lines, which create a paragraph break (HTML </p> and <p>).

Comment thread CONTRIBUTING.md

## Bug Reports
Make sure bug reports have enough information to be reproduced easily!
Make sure bug reports have enough information to be reproduced easily!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Make sure bug reports have enough information to be reproduced easily!
Make sure bug reports have enough information to be reproduced easily!\

In my opinion the flow of the document is better with the line breaks preserved, so this applies to all the line diffs where the only change is the removal of the double trailing whitespace.
Fortunately, ending a line with a backslash is another way to achieve a line break that's less prone to breaking due to autoformatters.

This suggestion applies to other diffs where the double trailing whitespace was removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

0: draft This PR is not ready for review yet (bot-managed)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants