Skip to content

Commit

Permalink
chore: update repository templates (#721)
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr authored Oct 1, 2020
1 parent 51d1702 commit ce9cb9f
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 40 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/closed_references.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,12 @@ jobs:
name: Find closed references
steps:
- uses: actions/checkout@v2
- uses: ory/closed-reference-notifier@v1.1.4
- uses: actions/setup-node@v2-beta
with:
node-version: '14'
- uses: ory/closed-reference-notifier@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
ignore: '.git,**/node_modules,docs,CHANGELOG.md,.bin,*.md'
ignore: ".git,**/node_modules,docs,CHANGELOG.md,.bin,*.md"
issueLabels: upstream
issueLimit: ${{ github.event.inputs.issueLimit || '5' }}
18 changes: 8 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,11 @@ 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 -->


- [Introduction](#introduction)
- [Contributing Code](#contributing-code)
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
Expand Down Expand Up @@ -143,23 +141,23 @@ please include a note in your commit message explaining why.

## How We Organize Our Work

All repositories in the [ORY organization](https://github.com/ory) have their issues and pull requests
All repositories in the [ORY organization](https://github.com/ory) have their issues and pull requests
monitored in the [ORY Monitoring Board](https://github.com/orgs/ory/projects/9). This allows
for a transparent backlog of unanswered issues and pull requests across the ecosystem from those
who are allowed to merge pull requests to the main branch.

The process is as follows:

1. *Cards* represent open issues and pull requests and are automatically assigned to the **Triage** column if
the author is not one of the maintainers and no maintainer has answered yet.
2. A maintainer assigns the issue or pull request to someone or adds the label *help wanted*
which moves the card to **Requires Action**.
1. _Cards_ represent open issues and pull requests and are automatically assigned to the **Triage** column if
the author is not one of the maintainers and no maintainer has answered yet.
2. A maintainer assigns the issue or pull request to someone or adds the label _help wanted_
which moves the card to **Requires Action**.
3. If a maintainer leaves a comment or review, the card moves to **Pending Reply**, implying that
the original author needs to do something (e.g. implement a change, explain something in more detail, ...).
the original author needs to do something (e.g. implement a change, explain something in more detail, ...).
4. If a non-maintainer pushes changes to the pull request or leaves a comment, the card moves
back to **Requires Action**.
back to **Requires Action**.
5. If a card stays inactive for 60 days or more days, we assume that public interest in the issue
or change has waned, **archiving** the card.
or change has waned, **archiving** the card.
6. If the issue is closed or the pull request merged or closed, the card is **archived** as well.

We try our best to answer all issues and review all pull requests and hope that this transparent way
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ TheCrealm.




## Getting Started

To get started, head over to the [ORY Kratos Documentation](https://www.ory.sh/kratos/docs).
Expand Down Expand Up @@ -295,6 +296,7 @@ to perform a certain action on a resource.




## Security

Running identity infrastructure requires [attention and knowledge of threat models](https://www.ory.sh/kratos/docs/concepts/security).
Expand Down
1 change: 0 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ 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 -->


- [Security Policy](#security-policy)
- [Supported Versions](#supported-versions)
- [Reporting a Vulnerability](#reporting-a-vulnerability)
Expand Down
48 changes: 21 additions & 27 deletions docs/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@ Please follow these guidelines when formatting source code:
Please provide documentation when changing, removing, or adding features.
Documentation resides in the project's `docs` folder.

In cases where a project does not have a `docs` folder check the README for
instructions.
In cases where a project does not have a `docs` folder check the README for instructions.

The commands listed below work exclusively for projects with a `docs` folder

Expand All @@ -109,8 +108,8 @@ To start a local development server with hot reloading, run:
$ npm start
```

This command opens up a browser window. Please note that changes to the sidebar
are not hot-reloaded and require a restart of the command.
This command opens up a browser window. Please note that changes to the sidebar are not hot-reloaded
and require a restart of the command.

#### Build

Expand Down Expand Up @@ -147,32 +146,27 @@ please include a note in your commit message explaining why.

## How We Organize Our Work

All repositories in the [ORY organization](https://github.com/ory) have their
issues and pull requests monitored in the
[ORY Monitoring Board](https://github.com/orgs/ory/projects/9). This allows for
a transparent backlog of unanswered issues and pull requests across the
ecosystem from those who are allowed to merge pull requests to the main branch.
All repositories in the [ORY organization](https://github.com/ory) have their issues and pull requests
monitored in the [ORY Monitoring Board](https://github.com/orgs/ory/projects/9). This allows
for a transparent backlog of unanswered issues and pull requests across the ecosystem from those
who are allowed to merge pull requests to the main branch.

The process is as follows:

1. _Cards_ represent open issues and pull requests and are automatically
assigned to the **Triage** column if the author is not one of the maintainers
and no maintainer has answered yet.
2. A maintainer assigns the issue or pull request to someone or adds the label
_help wanted_ which moves the card to **Requires Action**.
3. If a maintainer leaves a comment or review, the card moves to **Pending
Reply**, implying that the original author needs to do something (e.g.
implement a change, explain something in more detail, ...).
4. If a non-maintainer pushes changes to the pull request or leaves a comment,
the card moves back to **Requires Action**.
5. If a card stays inactive for 60 days or more days, we assume that public
interest in the issue or change has waned, **archiving** the card.
6. If the issue is closed or the pull request merged or closed, the card is
**archived** as well.

We try our best to answer all issues and review all pull requests and hope that
this transparent way of keeping a backlog helps you better understand how heavy
the workload is.
1. _Cards_ represent open issues and pull requests and are automatically assigned to the **Triage** column if
the author is not one of the maintainers and no maintainer has answered yet.
2. A maintainer assigns the issue or pull request to someone or adds the label _help wanted_
which moves the card to **Requires Action**.
3. If a maintainer leaves a comment or review, the card moves to **Pending Reply**, implying that
the original author needs to do something (e.g. implement a change, explain something in more detail, ...).
4. If a non-maintainer pushes changes to the pull request or leaves a comment, the card moves
back to **Requires Action**.
5. If a card stays inactive for 60 days or more days, we assume that public interest in the issue
or change has waned, **archiving** the card.
6. If the issue is closed or the pull request merged or closed, the card is **archived** as well.

We try our best to answer all issues and review all pull requests and hope that this transparent way
of keeping a backlog helps you better understand how heavy the workload is.

## Communication

Expand Down

0 comments on commit ce9cb9f

Please sign in to comment.