-
Notifications
You must be signed in to change notification settings - Fork 3k
Introduce policy for new images/packages #2016
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Policy on adding new images and packages | ||
|
|
||
| There are many things we consider, while adding new images and packages. | ||
|
|
||
| Here is a non exhaustive list of things we do care about: | ||
|
|
||
| 1. **Software health**, details, and maintenance status | ||
| - reasonable versioning is adopted, and the version is considered to be stable | ||
| - has been around for several years | ||
| - the package maintains documentation | ||
| - a changelog is actively maintained | ||
| - a release procedure with helpful automation is established | ||
| - multiple people are involved in the maintenance of the project | ||
| - provides a `conda-forge` package besides a `pypi` package, where both are kept up to date | ||
| - supports both `x86_64` and `aarch64` architectures | ||
| 2. **Installation consequences** | ||
| - GitHub Actions build time | ||
| - Image sizes | ||
| - All requirements should be installed as well | ||
| 3. Jupyter Docker Stacks _**image fit**_ | ||
| - new package or stack is changing (or inherits from) the most suitable stack | ||
| 4. **Software impact** for users of docker-stacks images | ||
| - How this image can help existing users, or maybe reduce the need to build new images | ||
| 5. Why it shouldn't just be a documented **recipe** | ||
| 6. Impact on **security** | ||
| - Does the package open additional ports, or add new web endpoints, that could be exploited? | ||
|
|
||
| With all this in mind, we have a voting group, which consists of | ||
| [mathbunnyru](http://github.com/mathbunnyru), | ||
| [consideRatio](http://github.com/consideRatio), | ||
| [yuvipanda](https://github.com/yuvipanda) and | ||
| [minrk](https://github.com/minrk). | ||
|
|
||
| This voting group is responsible for accepting or declining new packages and stacks. | ||
| The change is accepted, if there are **at least 2 positive votes**. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@consideRatio @yuvipanda @minrk how do you feel about this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 for the simplicity of this!