Skip to content

Commit

Permalink
prepare for github
Browse files Browse the repository at this point in the history
  • Loading branch information
Arnulf Heimsbakk committed Jul 13, 2020
1 parent 0e516bc commit 4123aa9
Show file tree
Hide file tree
Showing 9 changed files with 504 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Hi!

I've read `CODE_OF_CONDUCT.md` in this repository, and want to report a [bug/issue].

[Description]
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Hi!

I'd like to contribute [feature|bugfix|documentation].

[Description]

I confirm that my contributions will be compatible with the GPLv2.0 license guidelines.

* [ ] I have read and accepted both license and code of conduct.
* [ ] I have previously accepted and still accept both license and code of conduct.
20 changes: 20 additions & 0 deletions .github/workflows/ansible-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Ansible Lint

on: [push, pull_request]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Lint Ansible Playbook
uses: ansible/ansible-lint-action@master
with:
targets: ""
#override-deps: |
# ansible==2.9
# ansible-lint==4.2.0
args: ""
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## 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, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, 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

Examples of unacceptable behavior by participants include:

* 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
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

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.

## 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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project 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
members of the project's leadership.

## Attribution

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

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing to this project

This is an open source project, and we welcome contributions of all kinds.

* By contributing, you agree that we may redistribute your work under the [GPLv2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) license.
* Everyone involved in this project agrees to abide by [Contributor Covenant Code of Conduct v1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).

## Submitting bug reports

Ensure that you're running the latest stable version of this software. Submit a new issue with the bug report, ensure that it includes enough information to reproduce the problem. Include target platform, version and version of relevant libraries.

## Contributing code

* Contributions are managed via GitHub pull requests, usually as a response for an issue.
* Pull requests should contain the template below, where you tick off that you agree to license and code of conduct.
* Contributors will be listed in [CONTRIBUTORS.md](CONTRIBUTORS.md).

### Pull request template

```
Hi!
I'd like to contribute [feature|bugfix|documentation].
[Description]
I confirm that my contributions will be compatible with the GPLv2.0 license guidelines.
* [ ] I have read and accepted both license and code of conduct.
* [ ] I have previously accepted and still accept both license and code of conduct.
```

## Development guidelines

### Ansible

* Follow [MET Ansible Style Guide v1.0.0](https://github.com/metno/ansible-styleguide).
* Testing of the role must work with free operating systems; operating systems without license cost.
* Documentation must be updated with the to reflect code and versioning.
* New features should be implemented for all operating systems a role supports.
* Changes to a feature should be implemented for all operating systems the role supports.
* Commits should be granular enough for others to understand and review.
* Commits should be descriptive and contain reference to issue number if it exists, e.g. #1234.

<!---
# vim: set spell spelllang=en:
-->
3 changes: 3 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributors

* [MET Norway](https://www.met.no/) --- initial version
Loading

0 comments on commit 4123aa9

Please sign in to comment.