From b05f51f673d27f21257bf4b25534b0a77f101db2 Mon Sep 17 00:00:00 2001 From: Joachim Wiberg Date: Wed, 11 Jan 2023 18:07:12 +0100 Subject: [PATCH] Guidelines for how to contribute to the project Signed-off-by: Joachim Wiberg --- .github/CONTRIBUTING.md | 78 +++++++++++++++++++++++++++++++++++++++++ doc/MAINTAINERS | 2 ++ 2 files changed, 80 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 doc/MAINTAINERS diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..30da796d --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,78 @@ +Contributing to Infix +===================== + +We welcome any and all help in the form of bug reports, fixes, patches +to add new features -- *preferably as GitHub pull requests*. Other +methods are of course also possible: emailing the [maintainers][] a +patch or even a raw file, a feature request or an alert of a problem. + +If you are unsure of what to do, or how to implement an idea or bugfix, +open an issue with `"[RFC: Unsure if this is a bug ... ?"`, or use the +GitHub discussions forum, so we can discuss it. Talking about the code +first is the best way to get started before submitting a pull request. + +Either way, when sending an email, patch, or pull request, start by +stating the version the change is made against, what it does, and why. + +Please take care to ensure you follow the project coding style and the +commit message format. If you follow these recommendations you help +the maintainer(s) and make it easier for them to include your code. + + +Coding Style +------------ + +> **Tip:** Always submit code that follows the style of surrounding code! + +First of all, lines are allowed to be longer than 72 characters these +days. In fact, there exist no enforced maximum, but keeping it around +100 chars is OK. + +The coding style itself is otherwise strictly Linux [KNF][]. + + +Commit Messages +--------------- + +Commit messages exist to track *why* a change was made. Try to be as +clear and concise as possible in your commit messages, and always, be +proud of your work and set up a proper GIT identity for your commits: + + git config --global user.name "Jane Doe" + git config --global user.email jane.doe@example.com + +Example commit message from the [Pro Git][gitbook] online book, notice +how `git commit -s` is used to automatically add a `Signed-off-by`: + + Brief, but clear and concise summary of changes + + More detailed explanatory text, if necessary. Wrap it to about 72 + characters or so. In some contexts, the first line is treated as + the subject of an email and the rest of the text as the body. The + blank line separating the ummary from the body is critical (unless + you omit the body entirely); tools like rebase can get confused if + you run the two together. + + Further paragraphs come after blank lines. + + - Bullet points are okay, too + + - Typically a hyphen or asterisk is used for the bullet, preceded + by a single space, with blank lines in between, but conventions + vary here + + Signed-off-by: Jane Doe + + +Code of Conduct +--------------- + +It is expected of everyone to respect the [Code of Conduct][conduct]. +The *"maintainers have the right and responsibility to remove, edit, +or reject comments, commits, code, wiki edits, issues, and other +contributions that are not aligned to this Code of Conduct."* + +[1]: ../doc/MAINTAINERS +[KNF]: https://en.wikipedia.org/wiki/Kernel_Normal_Form +[gitbook]: https://git-scm.com/book/ch5-2.html +[conduct]: CODE-OF-CONDUCT.md diff --git a/doc/MAINTAINERS b/doc/MAINTAINERS new file mode 100644 index 00000000..c4100e81 --- /dev/null +++ b/doc/MAINTAINERS @@ -0,0 +1,2 @@ +Tobias Waldekranz +Joachim Wiberg