Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added community files. #29

Merged
merged 1 commit into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Probleem melden / Bug report
description: Meldt een probleem om ons te helpen verbeteren / Create a report to help us improve
title: "Title here"
labels: ["bug", "triage"]
projects: ["maykinmedia/15"]
assignees: []
body:
- type: input
id: product-version
attributes:
label: Product versie / Product version
description: Welke versie gebruikt u? / Which version do you use?
placeholder: "1.1.0"
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: Omschrijf het probleem / Describe the bug
description: Een duidelijke omschrijving van het probleem (de "bug") / A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Stappen om te reproduceren / Steps to reproduce
description: Stappen die leiden tot het probleem / Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: false
- type: textarea
id: expected-behaviour
attributes:
label: Verwacht gedrag / Expected behavior
description: Een duidelijke omschrijving van wat de verwachting is / A clear and concise description of what you expected to happen.
validations:
required: false
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Verzoek tot verbetering / Feature request
description: Stel een idee voor om het product beter te maken / Suggest an idea for this product
title: "Title here"
labels: ["enhancement", "triage"]
projects: ["maykinmedia/15"]
assignees: []
body:
- type: dropdown
id: theme
attributes:
label: Thema / Theme
options:
- "API"
- "Admin"
- "Other"
validations:
required: true
- type: textarea
id: description
attributes:
label: Omschrijving / Description
description: Omschrijf duidelijk het idee of de behoefte, eventueel aangevuld met een bepaalde oplossingsrichting / Clearly describe the idea or need, possibly supplemented with a specific solution direction
validations:
required: true
- type: textarea
id: added-value
attributes:
label: Toegevoegde waarde / Added value
description: Omschrijf de toegevoegde waarde voor de bedrijfsvoering of dienstverlening / Describe the added value for business operations or services
validations:
required: false
- type: textarea
id: remarks
attributes:
label: Aanvullende opmerkingen / Additional context
description: Voeg aanvullingen of mockups toe voor deze verbetering / Add any other context or screenshots about the feature request
validations:
required: false
5 changes: 5 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Ondersteuning met prioriteit / Priority support
url: https://opengem.nl/contact/
about: Neem direct contact met ons op / Contact us directly to get priority support.
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Fixes #

**Changes**

[Describe the changes here]

73 changes: 73 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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 at `[email protected]`. 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
76 changes: 76 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contribution guidelines

If you want to contribute, we ask you to follow these guidelines.

## Reporting bugs

If you have encountered a bug in this project, please check if an issue already
exists in the list of existing [issues][issues]. If such an issue does not
exist, you can create a [new issue][new_issue]. When writing the bug report,
try to add a clear example that shows how to reproduce said bug.

## Adding new features

Before making making changes to the code, we advise you to first check the list
of existing [issues][issues] for this project to see if an issue for the
suggested changes already exists. If such an issue does not exist, you can
create a [new issue][new_issue]. Creating an issue gives an opportunity for
other developers to give tips even before you start coding.

### Code style

To keep the code clean and readable, this project uses:

- [`isort`](https://github.com/timothycrosley/isort) to order the imports
- [`black`](https://github.com/psf/black) to format the code and keep diffs for
pull requests small
- [`flake8`](https://github.com/PyCQA/flake8) to clean up code (removing unused
imports, etc.)

Whenever a branch is pushed or a pull request is made, the code will be checked
in CI by the tools mentioned above, so make sure to install these tools and run
them locally before pushing branches/making pull requests.

This project aims to meet the criteria of the
[Standard for Public Code][Standard_for_Public_Code]. Please make sure that
your pull requests are compliant, that will make the reviews quicker.

### Forking the repository

In order to implement changes to this project when you do not have rights for
this [repository][repository], you must first fork the repository. Once the
repository is forked, you can clone it to your local machine.

### Making the changes

On your local machine, create a new branch, and name it like:
- `feature/some-new-feature`, if the changes implement a new feature
- `issue/some-issue`, if the changes fix an issue

Once you have made changes or additions to the code, you can commit them (try
to keep the commit message descriptive but short). If an issue already exists
in the list of existing [issues][issues] for the changes you made, be sure to
format your commit message like
`:gitmoji: Fixes #<issue_id> -- description of changes made`, where
`<issue_id>` corresponds to the number of the issue on GitHub. To demonstrate
that the changes implement the new feature/fix the issue, make sure to also add
tests to the existing Django testsuite.

### Making a pull request

If all changes have been committed, you can push the branch to your fork of the
repository and create a pull request to the `master` branch of this project's
repository. Your pull request will be reviewed, if applicable, feedback will be
given and if everything is approved, it will be merged.

### Reviews on releases

All pull requests will be reviewed by a project member before they are merged
to a release branch.


[issues]: https://github.com/maykinmedia/open-api-framework/issues
[new_issue]: https://github.com/maykinmedia/open-api-framework/issues/new/choose
[mailinglist]: t.b.d.
[Standard_for_Public_Code]: https://standard.publiccode.net
[repository]: https://github.com/maykinmedia/open-api-framework
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2024 Maykin Media
Copyright © Maykin 2024

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
16 changes: 12 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@


Welcome to open-api-framework's documentation!
=================================================
Open API Framework
==================

:Version: 0.4.0
:Source: https://github.com/maykinmedia/open-api-framework
Expand Down Expand Up @@ -58,6 +56,16 @@ directory to the python path (or use ``python -m django <command>``):
# or other commands like:
# django-admin makemessages -l nl

License
=======

Copyright © Maykin 2024

Licensed under the `MIT license`.


.. _`MIT license`: LICENSE


.. |build-status| image:: https://github.com/maykinmedia/open-api-framework/workflows/Run%20CI/badge.svg
:alt: Build status
Expand Down
61 changes: 61 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Security policy

The development team is strongly committed to responsible reporting and
disclosure of security-related issues. As such, we've adopted and follow a set
of policies which conform to that ideal and are geared toward allowing us to
deliver timely security updates to the official distribution of the product.

## Reporting security issues

**Short version: please report security issues by emailing
[email protected].**

If you discover security issues in the product or related projects under the
same organization, we request you to disclose these in a *responsible* way by
mailing to [email protected].

It is extremely useful if you have a reproducible test case and/or clear steps
on how to reproduce the vulnerability.

Please do not report security issues on the public Github issue tracker, as
this makes it visible which exploits exist before a fix is available,
potentially comprising a lot of unprotected instances.

Once you've submitted an issue via email, you should receive an acknowledgment
from a member of the security team as soon as possible, and depending on the
action to be taken, you may receive further followup emails.

# Timeline of the process

The product's community support is provided by [Maykin]. The community support
team is responsible for the handling of security issues.

1. The recipients of the report first validate if there is indeed a (possible)
issue.

2. After validation, we confirm that we received the report and if it is indeed
a valid issue.

3. We have a private Github repository accessible only to the community support
team. In this repository, an issue is created for the vulnerability where
the impact and possible solutions are discussed.

4. The next step is to create a (draft) Github security advisory, which is only
visible to the repository administrators and community support team.
Severity and impact will be established here.

5. If appropriate, we request a [CVE identifier][CVE_identifier] from Github.

6. A patch is implemented, reviewed and tested in a private fork.

7. When the fix is tested and release coordination is done, the fix is merged
into the primary repository. The security advisory and release are
published. All managed instances should be updated.

8. The release and security vulnerability are communicated to the community.
This includes an announcement on the most relevant public community
channels.


[CVE_identifier]: https://cve.mitre.org/cve/identifiers/
[Maykin]: https://www.maykinmedia.nl
Loading