Skip to content

Commit

Permalink
.github: align with template-repository (#144)
Browse files Browse the repository at this point in the history
* .github: align with template-repository
* github worflows: align on:
  • Loading branch information
gwarf authored Nov 19, 2020
1 parent 5c0bd0f commit 70fb259
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 45 deletions.
73 changes: 37 additions & 36 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,47 +7,49 @@ This code of conduct applies to the maintainers and contributors alike.
_We wish to add a specific section on dealing with issues opened against the
repository here._

This repository exists in the context of the EGI Federation. While that scope does
not restrict the usage, it does inform the priority we assign to issues and the
order we deal with them.
This repository exists in the context of the EGI Federation. While that scope
does not restrict the usage, it does inform the priority we assign to issues and
the order we deal with them.

We welcome issues reported by the public, and more specifically the community of
people using this repository.

We welcome issues reported by the public, and more specifically the community
of people using this repository.
The EGI team is small and cannot support all requests equally.
While we undertake to do everything in our power to respond to issues
timely, and to prioritise issues based on reasonable requests from

While we undertake to do everything in our power to respond to issues in a
timely manner, and to prioritise issues based on reasonable requests from
submitters, the maintainers expect that the prioritisation of issues as decided
by them is respected.

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age,
body size, disability, ethnicity, gender identity and expression, level of
experience, nationality, personal appearance, race, religion, or sexual
identity and orientation.
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, nationality, personal appearance, race, religion, or sexual identity
and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities
Expand All @@ -56,29 +58,29 @@ Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
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, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an
appointed representative at an online or offline event. Representation of a
project may be further defined and clarified by project maintainers.
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the EGI Foundation team at [email protected]. The team
will review and investigate all complaints, and will respond in a way that it
deems appropriate to the circumstances. The team is obligated to
maintain confidentiality with regard to the reporter of an incident. Further
details of specific enforcement policies may be posted separately.
reported by contacting the EGI Foundation team at [email protected]. The team will
review and investigate all complaints, and will respond in a way that it deems
appropriate to the circumstances. The team is obligated to maintain
confidentiality with regard to the reporter of an incident. Further details of
specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
Expand All @@ -87,8 +89,7 @@ members of the project's leadership.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
[http://contributor-covenant.org/version/1/4][version]
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!--
Thank you for opening an issue in our documentation.
Thank you for opening an issue in our repository.
Please use the template below to construct the issue.
Dealing with issues:
- Issues opened here will be evaluated by the maintainers, and given priority based
- Issues opened here will be evaluated by the maintainers, and given priority
based on that evaluation.
- Support is provided on a best-effort basis
- See the CODE_OF_CONDUCT.md for a deeper description of how we deal with support
Expand All @@ -12,7 +12,7 @@ Dealing with issues:

# Short Description of the issue

<!--
<!--
Please provide a plain-language description of what you would like to report.
By using simple, concise language, you can help the maintainers understand the
issue and context, and thereby help them prioritise it.
Expand Down
4 changes: 4 additions & 0 deletions .github/linters/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[flake8]
# https://black.readthedocs.io/en/stable/compatible_configs.html#flake8
extend-ignore = E203,W503
max-line-length = 88
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: Build documentation
# Deploy to GitHub pages
# https://github.com/peaceiris/actions-gh-pages

on: pull_request
on: [pull_request]

jobs:
deploy:
Expand Down
12 changes: 8 additions & 4 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
---
name: Check links

on: pull_request
on: [pull_request]

jobs:
markdown-link-check:
name: Check links using markdwon-link-check
name: Check links using markdown-link-check
runs-on: ubuntu-latest

steps:
# Checks out a copy of your repository on the ubuntu-latest machine
- name: Checkout code
uses: actions/checkout@master
uses: actions/checkout@v2

- name: Check links on new changes
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: "mlc_config.json"
config-file: ".github/linters/mlc_config.json"
check-modified-files-only: "yes"
use-quiet-mode: "yes"
use-verbose-mode: "yes"
base-branch: "master"
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Lint

on: pull_request
on: [pull_request]

jobs:
super-lint:
Expand Down

0 comments on commit 70fb259

Please sign in to comment.