From dec578e75122c0c32ef4d30ffb08e5222098205e Mon Sep 17 00:00:00 2001 From: Winni Neessen Date: Sun, 21 May 2023 11:46:23 +0200 Subject: [PATCH] Added CODE_OF_CONDUCT.md, CONTRIBUTING.md and updated mail address in CopyrightText --- .github/FUNDING.yml | 2 +- .github/workflows/codecov.yml | 2 +- .github/workflows/golangci-lint.yml | 2 +- .github/workflows/reuse.yml | 2 +- .github/workflows/sonarqube.yml | 2 +- .gitignore | 2 +- .golangci.toml | 2 +- CODE_OF_CONDUCT.md | 134 ++++++++++++++++++++++++++++ CONTRIBUTING.md | 35 ++++++++ README.md | 2 +- codecov.yml | 2 +- doc.go | 2 +- geolocation.go | 2 +- geolocation_test.go | 2 +- go.mod | 2 +- httpclient.go | 2 +- httpclient_test.go | 2 +- meteologix.go | 2 +- meteologix_test.go | 2 +- observation.go | 2 +- observation_test.go | 2 +- sonar-project.properties | 2 +- station.go | 2 +- station_test.go | 2 +- 24 files changed, 191 insertions(+), 22 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index faa0a8e..e56844d 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2023 Winni Neessen +# SPDX-FileCopyrightText: 2023 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml index 93045bb..7310729 100644 --- a/.github/workflows/codecov.yml +++ b/.github/workflows/codecov.yml @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2023 Winni Neessen +# SPDX-FileCopyrightText: 2023 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml index 7183a6d..4f70ab9 100644 --- a/.github/workflows/golangci-lint.yml +++ b/.github/workflows/golangci-lint.yml @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2022 Winni Neessen +# SPDX-FileCopyrightText: 2022 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml index 9f880ea..18167fb 100644 --- a/.github/workflows/reuse.yml +++ b/.github/workflows/reuse.yml @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2023 Winni Neessen +# SPDX-FileCopyrightText: 2023 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/.github/workflows/sonarqube.yml b/.github/workflows/sonarqube.yml index 1e7f85a..3a1c107 100644 --- a/.github/workflows/sonarqube.yml +++ b/.github/workflows/sonarqube.yml @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2023 Winni Neessen +# SPDX-FileCopyrightText: 2023 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/.gitignore b/.gitignore index 27c2bcf..e0a5648 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2023 Winni Neessen +# SPDX-FileCopyrightText: 2023 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/.golangci.toml b/.golangci.toml index 0d648dd..a5a7fb0 100644 --- a/.golangci.toml +++ b/.golangci.toml @@ -1,4 +1,4 @@ -## SPDX-FileCopyrightText: 2022 Winni Neessen +## SPDX-FileCopyrightText: 2022 Winni Neessen ## ## SPDX-License-Identifier: MIT diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c78d6d7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ + + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +github+coc@neessen.net. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3e3a1ff --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ + + +# How to contribute + +**Working on your first Pull Request?** You can learn how from this *free* +series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) + +## Guidelines for Pull Requests + +How to get your contributions merged smoothly and quickly. + +* Create **small PRs** that are narrowly focused on **addressing a single concern**. We often times receive PRs that are + trying to fix several things at a time, but only one fix is considered acceptable, nothing gets merged and both + author's & review's time is wasted. Create more PRs to address different concerns and everyone will be happy. + +* For speculative changes, consider opening an issue and discussing it first. + +* Provide a good **PR description** as a record of **what** change is being made and **why** it was made. Link to a + github issue if it exists. + +* Unless your PR is trivial, you should expect there will be reviewer comments that you'll need to address before + merging. We expect you to be reasonably responsive to those comments, otherwise the PR will be closed after 2-3 weeks + of inactivity. + +* Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult + to review and won't be merged. Use `rebase -i upstream/main` to curate your commit history and/or to bring in latest + changes from main (but avoid rebasing in the middle of a code review). + +* Keep your PR up to date with upstream/main (if there are merge conflicts, we can't really merge your change). + +* Exceptions to the rules can be made if there's a compelling reason for doing so. diff --git a/README.md b/README.md index 3192818..e8accdc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ diff --git a/codecov.yml b/codecov.yml index fbbd9fa..d8ed25c 100644 --- a/codecov.yml +++ b/codecov.yml @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2023 Winni Neessen +# SPDX-FileCopyrightText: 2023 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/doc.go b/doc.go index 5b53b2d..4d09dd0 100644 --- a/doc.go +++ b/doc.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/geolocation.go b/geolocation.go index 193ed04..08a6abc 100644 --- a/geolocation.go +++ b/geolocation.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/geolocation_test.go b/geolocation_test.go index d6480e6..027ab2d 100644 --- a/geolocation_test.go +++ b/geolocation_test.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/go.mod b/go.mod index a42e817..d921b0b 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/httpclient.go b/httpclient.go index f3b9a0e..058d733 100644 --- a/httpclient.go +++ b/httpclient.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/httpclient_test.go b/httpclient_test.go index 83a7868..028ee1c 100644 --- a/httpclient_test.go +++ b/httpclient_test.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/meteologix.go b/meteologix.go index 030eb74..411c201 100644 --- a/meteologix.go +++ b/meteologix.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/meteologix_test.go b/meteologix_test.go index ae02c8b..bcfbb5d 100644 --- a/meteologix_test.go +++ b/meteologix_test.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/observation.go b/observation.go index 2db5928..56f28fa 100644 --- a/observation.go +++ b/observation.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/observation_test.go b/observation_test.go index 43c46d6..79a9395 100644 --- a/observation_test.go +++ b/observation_test.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/sonar-project.properties b/sonar-project.properties index 9e5cbe1..c8c1fc5 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2023 Winni Neessen +# SPDX-FileCopyrightText: 2023 Winni Neessen # # SPDX-License-Identifier: CC0-1.0 diff --git a/station.go b/station.go index 9ee4f8d..4ea327d 100644 --- a/station.go +++ b/station.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT diff --git a/station_test.go b/station_test.go index 3dd17d6..a8e6322 100644 --- a/station_test.go +++ b/station_test.go @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 Winni Neessen +// SPDX-FileCopyrightText: 2023 Winni Neessen // // SPDX-License-Identifier: MIT