Skip to content

Commit

Permalink
Merge pull request #3 from metosin/project-status
Browse files Browse the repository at this point in the history
Add project status model
  • Loading branch information
vharmain authored May 20, 2022
2 parents 6e8c71e + 2434cd1 commit 5aac63d
Show file tree
Hide file tree
Showing 2 changed files with 112 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,13 @@ Here are some general guidelines:

# [For maintainers](./maintainers.md)

# Project lifecycle model
# [Project status model](./project-status.md)

Our projects generally go through the following stages:
We use a [project status model](./project-status.md) to track the maintenance status and maturity of our open source projects.

* **Experimental**: we're trying this out; there are no guarantees of stability or future of the project.
* **Under active development**: actively maintained and recommended; there may be upcoming breaking changes
* **Stable:** actively maintained; new releases are expected to be backwards-compatible
* **Deprecated:** not actively maintained nor recommended for new projects
* [Active projects](https://github.com/topics/metosin-active)
* [Stable projects](https://github.com/topics/metosin-stable)
* [Inactive projects](https://github.com/topics/metosin-inactive)
* [Experimental projects](https://github.com/topics/metosin-experimental)
* [Deprecated projects](https://github.com/topics/metosin-deprecated)
* [Example projects](https://github.com/topics/metosin-example)
104 changes: 104 additions & 0 deletions project-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Metosin Open Source Project Status

We use following project status model to track the maintenance status and maturity of our open source projects.

## Active

Active projects are actively developed by Metosin and contributors and recommended for use.

| | Metosin | Contributors |
|------------------------|--------------------|--------------|
| New features | Actively developed | PRs welcome |
| Feature requests |||
| Bug and security fixes |||
| Bug reports |||
| New releases | Often | |

Github tag: [metosin-active](https://github.com/topics/metosin-active)

```
[Metosin Open Source Status: Active](https://github.com/metosin/open-source/blob/main/project-status.md#active)
```

## Stable

Stable project are maintained by Metosin and recommended for use. No major new features expected from Metosin but PRs from collaborators are welcome.

| | Metosin | Contributors |
|------------------------|-----------|--------------|
| New features | | PRs welcome |
| Feature requests | | |
| Bug and security fixes |||
| Bug reports |||
| New releases | As needed | |

Github tag: [metosin-stable](https://github.com/topics/metosin-stable)

```
[Metosin Open Source Status: Stable](https://github.com/metosin/open-source/blob/main/project-status.md#stable)
```

## Inactive

Inactive projects are OK for production use and will receive security fixes but no new developments. Not recommended for new projects.

| | Metosin | Contributors |
|------------------------|-----------|---------------|
| New features | | Discuss first |
| Feature requests | | |
| Bug and security fixes |||
| Bug reports |||
| New releases | As needed | |

Github tag: [metosin-inactive](https://github.com/topics/metosin-inactive)

```
[Metosin Open Source Status: Inactive](https://github.com/metosin/open-source/blob/main/project-status.md#inactive)
```

## Experimental

Experimental projects are not recommended for production use and Metosin doesn't provide support or maintenance. Testing and feedback are welcome.

Github tag: [metosin-experimental](https://github.com/topics/metosin-experimental)

```
[Metosin Open Source Status: Experimental](https://github.com/metosin/open-source/blob/main/project-status.md#experimental)
```

## Deprecated

Deprecated projects are not recommended for anything. If you want new features, please fork.

| | Metosin | Contributors |
|------------------------|---------|--------------|
| New features | | |
| Feature requests | | |
| Bug and security fixes | | |
| Bug reports | | |
| New releases | Never | Please fork |

Github tag: [metosin-deprecated](https://github.com/topics/metosin-deprecated)

```
[Metosin Open Source Status: Deprecated](https://github.com/metosin/open-source/blob/main/project-status.md#deprecated)
```

## Example

Example repositories contain example projects and code snippets. Example projects are not actively maintained nor meant to be used as dependencies.

| | Metosin | Contributors |
|------------------------|---------|--------------|
| New features | | |
| Feature requests | | |
| Bug and security fixes | | |
| Bug reports | ||
| New releases | | |


Github tag: [metosin-example](https://github.com/topics/metosin-example)

```
[Metosin Open Source Status: Example](https://github.com/metosin/open-source/blob/main/project-status.md#example)
```

0 comments on commit 5aac63d

Please sign in to comment.