-
Notifications
You must be signed in to change notification settings - Fork 8
Add a CONTRIBUTING.md file with checks to execute before creating a PR #226
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
Open
nougad
wants to merge
1
commit into
fphammerle:master
Choose a base branch
from
nougad:contribution
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue with the owners of this repository before making a change. | ||
|
||
## Pull Request Process | ||
|
||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a | ||
build. | ||
Comment on lines
+7
to
+8
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you explain what you mean here? |
||
2. Update the README.md with details of changes to the interface, this includes new environment | ||
variables, exposed ports, useful file locations and container parameters. | ||
3. Update the `CHANGELOG.md` file with your changes under the `[Unreleased]` section. | ||
|
||
## Development Setup | ||
|
||
1. Install `pipenv`. | ||
2. Install dependencies with `pipenv install --dev`. | ||
|
||
## Running Checks | ||
|
||
Before submitting a pull request, please run the following checks to ensure your code is clean and passes all tests. | ||
|
||
### Code Formatting | ||
|
||
Run `black` to format your code: | ||
|
||
```bash | ||
pipenv run black . | ||
``` | ||
|
||
### Linting | ||
|
||
Run `pylint` to check for code style issues: | ||
|
||
```bash | ||
pipenv run pylint systemctl_mqtt | ||
pipenv run pylint tests/* | ||
``` | ||
|
||
### Static Type Checking | ||
|
||
Run `mypy` to check for type errors: | ||
|
||
```bash | ||
pipenv run mypy systemctl_mqtt tests | ||
``` | ||
|
||
### Testing | ||
|
||
Run `pytest` to run the test suite: | ||
|
||
```bash | ||
pipenv run pytest --cov=systemctl_mqtt --cov-report=term-missing --cov-fail-under=100 | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding
CONTRIBUTING.md
!I would say prior discussion is not necessary for all pull requests.
It would imho make sense if the planned pulled request introduced breaking changes or new features requiring lots of dev work.