mirror of
https://github.com/jupyter/docker-stacks.git
synced 2025-10-07 18:14:05 +00:00
Make features.md source code more readable
This commit is contained in:
@@ -1,8 +1,8 @@
|
|||||||
# New Features
|
# New Features
|
||||||
|
|
||||||
Thank you for contributing to the Jupyter Docker Stacks! We review pull requests for new features
|
Thank you for contributing to the Jupyter Docker Stacks!
|
||||||
(e.g., new packages, new scripts, new flags) to balance the value of the images to the Jupyter
|
We review pull requests for new features (e.g., new packages, new scripts, new flags)
|
||||||
community with the cost of maintaining the images over time.
|
to balance the value of the images to the Jupyter community with the cost of maintaining the images over time.
|
||||||
|
|
||||||
## Suggesting a New Feature
|
## Suggesting a New Feature
|
||||||
|
|
||||||
@@ -10,27 +10,33 @@ Please follow the process below to suggest a new feature for inclusion in one of
|
|||||||
|
|
||||||
1. Open a [GitHub feature request issue](https://github.com/jupyter/docker-stacks/issues/new?assignees=&labels=type%3AEnhancement&projects=&template=feature_request.yml)
|
1. Open a [GitHub feature request issue](https://github.com/jupyter/docker-stacks/issues/new?assignees=&labels=type%3AEnhancement&projects=&template=feature_request.yml)
|
||||||
describing the feature you'd like to contribute.
|
describing the feature you'd like to contribute.
|
||||||
2. Discuss with the maintainers whether the addition makes sense in
|
2. Discuss with the maintainers whether the addition makes sense
|
||||||
[one of the core stacks](../using/selecting.md#core-stacks), as a
|
in [one of the core stacks](../using/selecting.md#core-stacks),
|
||||||
[recipe in the documentation](recipes.md), as a [community stack](stacks.md), or as something
|
as a [recipe in the documentation](recipes.md),
|
||||||
else entirely.
|
as a [community stack](stacks.md),
|
||||||
|
or as something else entirely.
|
||||||
|
|
||||||
## Selection Criteria
|
## Selection Criteria
|
||||||
|
|
||||||
Roughly speaking, we evaluate new features based on the following criteria:
|
Roughly speaking, we evaluate new features based on the following criteria:
|
||||||
|
|
||||||
- **Usefulness to Jupyter users**: Is the feature generally applicable across domains? Does it work
|
- **Usefulness to Jupyter users**:
|
||||||
with JupyterLab, Jupyter Notebook, JupyterHub, etc.?
|
Is the feature generally applicable across domains?
|
||||||
- **Fit with the image purpose**: Does the feature match the theme of the stack in which it will be
|
Does it work with JupyterLab, Jupyter Notebook, JupyterHub, etc.?
|
||||||
added? Would it fit better in a new community stack?
|
- **Fit with the image purpose**:
|
||||||
- **Complexity of build/runtime configuration**: How many lines of code does the feature require
|
Does the feature match the theme of the stack in which it will be added?
|
||||||
in one of the Dockerfiles or startup scripts? Does it require new scripts entirely? Do users need
|
Would it fit better in a new community stack?
|
||||||
to adjust how they use the images?
|
- **Complexity of build/runtime configuration**:
|
||||||
- **Impact on image metrics**: How many bytes does the feature and its dependencies add to the
|
How many lines of code does the feature require in one of the Dockerfiles or startup scripts?
|
||||||
image(s)? How many minutes do they add to the build time?
|
Does it require new scripts entirely?
|
||||||
- **Ability to support the addition**: Can existing maintainers answer user questions and address
|
Do users need to adjust how they use the images?
|
||||||
future build issues? Are the contributors interested in helping with long-term maintenance? Can we
|
- **Impact on image metrics**:
|
||||||
write tests to ensure the feature continues to work over time?
|
How many bytes does the feature and its dependencies add to the image(s)?
|
||||||
|
How many minutes do they add to the build time?
|
||||||
|
- **Ability to support the addition**:
|
||||||
|
Can existing maintainers answer user questions and address future build issues?
|
||||||
|
Are the contributors interested in helping with long-term maintenance?
|
||||||
|
Can we write tests to ensure the feature continues to work over time?
|
||||||
|
|
||||||
## Submitting a Pull Request
|
## Submitting a Pull Request
|
||||||
|
|
||||||
@@ -43,7 +49,7 @@ If there's agreement that the feature belongs in one or more of the core stacks:
|
|||||||
If you use `make`, call:
|
If you use `make`, call:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make build/somestack-notebook
|
make build/<somestack>-notebook
|
||||||
```
|
```
|
||||||
|
|
||||||
3. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)(PR) with your changes.
|
3. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)(PR) with your changes.
|
||||||
|
Reference in New Issue
Block a user