Open
Conversation
Add issue templates: 1. Report a bug 2. Propose a change
Add default PR template for creating PRs
Add CI script to check if the files have been linted and formatted on push or PR
Add build CI that builds a runnable executable with pyinstaller for linux and windows
Add Codeowner file Codeowners will automatically be set as reviewers for PRs Add script to inform specific codeowners when Issues are created
Add initial changelog file for project
Add initial CONTRIBUTION.md for documentation how to contribute to the project
Included the contribution information in the README.md
Add how to run linter/formatter information in doc Add needed packages to requirements.txt
AKMaily
force-pushed
the
setup/OSContributerWorkflow
branch
from
ad929c4 to
45211d0
Compare
Run lint and formatter about src code files Used black, isort, flake8
Collaborator
Author
|
@MaxClerkwell @PhilippTheServer your opinions to this workflow and especially the git CI would be greatly appreciated. I am currently not sure how to setup automatic versioning for PRs that are merged into the master branch. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR introduces a automatic and documented contribution workflow.
Regarding #16 this is needed to make the contribution and review process easier for maintainers and contributers .
This includes:
A documented workflow in the CONTRIBUTION.md
A CHANGELOG.md to keep track of changes.
Issue and PR templates.
A Codeowner file for automatic review and issue assignements
Github Actions to :
Testing:
The workflows should trigger with this PR.
Everything else can only be tested when merged into the master .