From 93d08188ea72892eb8d09660ed445a17ef0dc3c6 Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Wed, 8 Mar 2023 20:51:38 +0100 Subject: [PATCH] feat(docs): Add CONTRIBUTING.md --- .gitlint | 14 ++++++++++++++ CONTRIBUTING.md | 19 +++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 .gitlint create mode 100644 CONTRIBUTING.md diff --git a/.gitlint b/.gitlint new file mode 100644 index 0000000..cd9de33 --- /dev/null +++ b/.gitlint @@ -0,0 +1,14 @@ +[general] +ignore=B5,B6,B7,B8 + +[title-max-length] +line-length=72 + +[title-trailing-punctuation] +[title-hard-tab] +[title-match-regex] +regex=^((feat|fix|chore|refactor|docs|release|test)\((meta|tests|style|docs|xep|core)+(,(meta|tests|style|docs|xep|core))*\)|release): [A-Z0-9].*$ + + +[body-trailing-whitespace] +[body-first-line-empty] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a44921d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contribution Guide + +Thanks for your interest in the moxxmpp XMPP library! This document contains guidelines and guides for working on the moxxmpp codebase. + +## Contributing + +If you want to fix a small issue, you can just fork, create a new branch, and start working right away. However, if you want to work +on a bigger feature, please first create an issue (if an issue does not already exist) or join the [development chat](xmpp:moxxy@muc.moxxy.org?join) (xmpp:moxxy@muc.moxxy.org?join) +to discuss the feature first. + +Before creating a pull request, please make sure you checked every item on the following checklist: + +- [ ] I formatted the code with the dart formatter (`dart format`) before running the linter +- [ ] I ran the linter (`dart analyze`) and introduced no new linter warnings +- [ ] I ran the tests (`dart test`) and introduced no new failing tests +- [ ] I used [gitlint](https://github.com/jorisroovers/gitlint) to ensure propper formatting of my commig messages + +If you think that your code is ready for a pull request, but you are not sure if it is ready, prefix the PR's title with "WIP: ", so that discussion +can happen there. If you think your PR is ready for review, remove the "WIP: " prefix.