diff --git a/docs/CODE-OF-CONDUCT.md b/docs/CODE-OF-CONDUCT.md new file mode 100644 index 0000000..2770e03 --- /dev/null +++ b/docs/CODE-OF-CONDUCT.md @@ -0,0 +1,44 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of +fostering an open and welcoming community, we pledge to respect all +people who contribute through reporting issues, posting feature +requests, updating documentation, submitting pull requests or patches, +and other activities. + +We are committed to making participation in this project a +harassment-free experience for everyone, regardless of level of +experience, gender, gender identity and expression, sexual orientation, +disability, personal appearance, body size, race, ethnicity, age, +religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic + addresses, without explicit permission +* Other unethical or unprofessional conduct. + +Project 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. By adopting +this Code of Conduct, project maintainers commit themselves to fairly +and consistently applying these principles to every aspect of managing +this project. Project maintainers who do not follow or enforce the Code +of Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public +spaces when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may +be reported by opening an issue or contacting one or more of the project +maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant][1], +[version 1.2.0][2]. + +[1]: http://contributor-covenant.org +[2]: http://contributor-covenant.org/version/1/2/0/ diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..80f40b2 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,80 @@ +Contributing to sysklogd +======================== + +We welcome any and all help in the form of bug reports, fixes, patches +for new features, *preferably as GitHub pull requests*. Other methods +are of course also possible: emailing the maintainer a patch or even a +raw file, or simply emailing a feature request or an alert of a problem. +However, email questions/requests/alerts always risk memory exhaustion +on the part of the maintainer(s). + +If you are unsure of what to do, or how to implement an idea or bug fix, +open an issue with the title `"[RFC: Unsure if this is a bug ... ?"`, +or similar, 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 most +importanyl -- 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 engaging in the project to, in the words of +Bill & Ted; [be excellent to each other][conduct]. + + +[KNF]: https://en.wikipedia.org/wiki/Kernel_Normal_Form +[gitbook]: https://git-scm.com/book/ch5-2.html +[conduct]: https://github.com/troglobit/sysklogd/blob/master/docs/CODE-OF-CONDUCT.md +