Skip to content

Commit

Permalink
docs: update repository templates
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Aug 29, 2020
1 parent fce9a6f commit 56db92f
Show file tree
Hide file tree
Showing 8 changed files with 139 additions and 11 deletions.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: ORY Community
url: https://community.ory.sh/
about: Please ask and answer questions here.
- name: ORY Chat
url: https://www.ory.sh/chat
about: Hang out with other ORY community members and ask and answer questions.
- name: ORY Enterprise Contact
url: https://www.ory.sh/contact
about: Jared will help you with your enterprise-related inquiries.
17 changes: 17 additions & 0 deletions .github/semantic.yml
@@ -0,0 +1,17 @@
titleOnly: true
commitsOnly: false
titleAndCommits: false

types:
- feat
- fix
- revert
- docs
- style
- refactor
- test
- build
- autogen
- security
- ci
- chore
24 changes: 24 additions & 0 deletions .github/workflows/closed_references.yml
@@ -0,0 +1,24 @@
name: Closed Reference Notifier

on:
schedule:
- cron: '0 7 * * *'
workflow_dispatch:
inputs:
issueLimit:
description: Max. number of issues to create
required: true
default: '5'

jobs:
find_closed_references:
runs-on: ubuntu-latest
name: Find closed references
steps:
- uses: actions/checkout@v2
- uses: ory/closed-reference-notifier@v1.1.4
with:
token: ${{ secrets.GITHUB_TOKEN }}
ignore: '.git,**/node_modules,docs,CHANGELOG.md,.bin'
issueLabels: upstream
issueLimit: ${{ github.event.inputs.issueLimit || '5' }}
21 changes: 21 additions & 0 deletions .github/workflows/labels.yml
@@ -0,0 +1,21 @@
name: Synchronize Issue Labels

on:
workflow_dispatch:
push:
branches:
- master

jobs:
milestone:
name: Synchronize Issue Labels
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Synchronize Issue Labels
uses: ory/label-sync-action@v0
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
dry: false
forced: true
24 changes: 24 additions & 0 deletions .github/workflows/stale.yml
@@ -0,0 +1,24 @@
name: "Close Stale Issues"
on:
workflow_dispatch:
schedule:
- cron: "0 0 * * *"

jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: |
Thank you for opening this issue. It appears that the request for more information (e.g. providing the software version, providing logs, ...) has not yet been completed. Therefore this issue will be automatically
closed in 7 days, assuming that the issue has been resolved.
stale-pr-message: |
Thank you for opening this pull request. It appears that a request for e.g. information has not yet been completed. Therefore this issue will be automatically
closed in 7 days, assuming that the proposed change is no longer required or has otherwise been resolved.
stale-issue-label: 'stale'
stale-pr-label: 'stale'
only-labels: 'needs more info'
days-before-stale: 7
days-before-close: 7
42 changes: 32 additions & 10 deletions CONTRIBUTING.md
@@ -1,4 +1,15 @@
# Contributing to ORY Dockertest
<!--
Thank you for contributing changes to this document! Because we use a central repository
to synchronize this file across all our repositories, make sure to make your edits
in the correct file, which you can find here:
https://github.com/ory/meta/blob/master/templates/repository/CONTRIBUTING.md
-->


# Contributing to ORY {{Project}}

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand All @@ -8,6 +19,7 @@
- [Contributing Code](#contributing-code)
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
- [Code Style](#code-style)
- [Documentation](#documentation)
- [Pull request procedure](#pull-request-procedure)
- [Communication](#communication)
- [Conduct](#conduct)
Expand All @@ -16,9 +28,9 @@

## Introduction

Please note: We take ORY Dockertest's security and our users' trust very
seriously. If you believe you have found a security issue in ORY Dockertest,
please responsibly disclose by contacting us at hi@ory.sh.
Please note: We take ORY {{Project}}'s security and our users' trust very
seriously. If you believe you have found a security issue in ORY {{Project}},
please responsibly disclose by contacting us at office@ory.sh.

First: if you're unsure or afraid of anything, just ask or submit the issue or
pull request anyways. You won't be yelled at for giving it your best effort. The
Expand All @@ -28,15 +40,15 @@ the way of that.

That said, if you want to ensure that a pull request is likely to be merged,
talk to us! You can find out our thoughts and ensure that your contribution
won't clash or be obviated by ORY Dockertest's normal direction. A great way to
won't clash or be obviated by ORY {{Project}}'s normal direction. A great way to
do this is via the [ORY Community](https://community.ory.sh/) or join the
[ORY Chat](https://www.ory.sh/chat).

## Contributing Code

Unless you are fixing a known bug, we **strongly** recommend discussing it with
the core team via a GitHub issue or [in our chat](https://www.ory.sh/chat)
before getting started to ensure your work is consistent with ORY Dockertest's
before getting started to ensure your work is consistent with ORY {{Project}}'s
roadmap and architecture.

All contributions are made via pull request. Note that **all patches from all
Expand All @@ -55,14 +67,24 @@ should be merged by the submitter after review.

## Disclosing vulnerabilities

Please disclose vulnerabilities exclusively to [hi@ory.am](mailto:hi@ory.am). Do
not use GitHub issues.
Please disclose vulnerabilities exclusively to
[security@ory.sh](mailto:security@ory.sh). Do not use GitHub issues.

## Code Style

Please follow these guidelines when formatting source code:

- Go code should match the output of `gofmt -s`
- Go code should match the output of `gofmt -s` and pass `golangci-lint run`.
- NodeJS and JavaScript code should be prettified using `npm run format` where
appropriate.

## Documentation

Please provide documentation when changing, removing, or adding features.
Documentation resides in the project's [docs](docs) folder. Generate API and
configuration reference documentation using `cd docs; npm run gen`.

For further instructions please head over to [docs/README.md](docs/README.md).

## Pull request procedure

Expand Down Expand Up @@ -110,7 +132,7 @@ community a safe place for you and we've got your back.
- Private harassment is also unacceptable. No matter who you are, if you feel
you have been or are being harassed or made uncomfortable by a community
member, please contact one of the channel ops or a member of the ORY
Dockertest core team immediately.
{{Project}} core team immediately.
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing
behaviour is not welcome.

Expand Down
1 change: 0 additions & 1 deletion LICENSE
@@ -1,4 +1,3 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Expand Down
10 changes: 10 additions & 0 deletions SECURITY.md
@@ -1,3 +1,13 @@
<!--
Thank you for contributing changes to this document! Because we use a central repository
to synchronize this file across all our repositories, make sure to make your edits
in the correct file, which you can find here:
https://github.com/ory/meta/blob/master/templates/repository/SECURITY.md
-->

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Expand Down

0 comments on commit 56db92f

Please sign in to comment.