Thanks for taking the time to contribute!
PenText uses the GitHub flow as main versioning workflow. In short,
- Fork the PenText repository
- Create a new branch for each feature, fix, or improvement
- Send a pull request from each feature branch to the master branch
Please create pull requests that are as atomic as possible, and only implement one feature, fix, or improvement at a time. That makes it easier to review and merge the changes.
All commits and pull requests SHOULD adhere to the
Conventional Commits specification. This
allows us, maintainers, to use the tool commit-and-tag-version
to
automagically create the CHANGELOG.md file.
Conventional commits is a specification for making commit messages machine readable and informing automation tools about the context of the commit.
All HTML and XML files are formatted with zpretty
All Markdown files are formatted and linted with Prettier.
All Python scripts are formatted with black.
We want to ensure that PenText remains free and open source software. By contributing, you agree that your contributions will be licensed under the same license PenText falls under, the GPLv2 license.