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

Additions to the Coding Conventions and Pull Request sections in the Contribution Guidelines #180

Merged
merged 6 commits into from Dec 18, 2019

Conversation

@Puddlestomper
Copy link
Contributor

Puddlestomper commented Nov 29, 2019

Proposed fix (Make sure you've read on how to contribute to Hazel)

This PR expands on the coding conventions section of the contribution guidelines with regards to the naming scheme and adds points to the writing of a good PR.

The expansion of the coding conventions now lists all naming conventions.

The points added to "Writing a Good Pull Request" are:

  • A reminder to be sure that submitted code compiles and passes all tests (when we do eventually set that up).
  • A reminder to use closing keywords.
  • A reminder to use descriptive commit messages.

There is also some general maintenance in the form of moving the links down to make the raw file more readable.

EDIT: Added more changes to the description above.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@LovelySanta LovelySanta added this to Bugfixes (awaiting merge) in Community additions Dec 1, 2019
@Puddlestomper Puddlestomper changed the title Additions to Coding Conventions Section in the Contribution Guidelines Additions to the Coding Conventions and Pull Request sections in the Contribution Guidelines Dec 3, 2019
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
Puddlestomper and others added 2 commits Dec 3, 2019
Co-Authored-By: lovely_santa <laurens.scheldeman@gmail.com>
@LovelySanta LovelySanta merged commit 7e97921 into TheCherno:master Dec 18, 2019
Community additions automation moved this from Bugfixes (awaiting merge) to Merged PR's Dec 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Community additions
  
Merged PR's
2 participants
You can’t perform that action at this time.