From e1ad1e302b132c842c4bbbc7cd6918f1fe8e822f Mon Sep 17 00:00:00 2001 From: Ayaz Salikhov Date: Sat, 21 Oct 2023 19:44:15 +0200 Subject: [PATCH] Make features.md source code more readable --- docs/contributing/features.md | 46 ++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 20 deletions(-) diff --git a/docs/contributing/features.md b/docs/contributing/features.md index 83684174..376a7c9b 100644 --- a/docs/contributing/features.md +++ b/docs/contributing/features.md @@ -1,8 +1,8 @@ # New Features -Thank you for contributing to the Jupyter Docker Stacks! We review pull requests for new features -(e.g., new packages, new scripts, new flags) to balance the value of the images to the Jupyter -community with the cost of maintaining the images over time. +Thank you for contributing to the Jupyter Docker Stacks! +We review pull requests for new features (e.g., new packages, new scripts, new flags) +to balance the value of the images to the Jupyter community with the cost of maintaining the images over time. ## 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) describing the feature you'd like to contribute. -2. Discuss with the maintainers whether the addition makes sense in - [one of the core stacks](../using/selecting.md#core-stacks), as a - [recipe in the documentation](recipes.md), as a [community stack](stacks.md), or as something - else entirely. +2. Discuss with the maintainers whether the addition makes sense + in [one of the core stacks](../using/selecting.md#core-stacks), + as a [recipe in the documentation](recipes.md), + as a [community stack](stacks.md), + or as something else entirely. ## Selection 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 - with JupyterLab, Jupyter Notebook, JupyterHub, etc.? -- **Fit with the image purpose**: Does the feature match the theme of the stack in which it will be - added? Would it fit better in a new community stack? -- **Complexity of build/runtime configuration**: How many lines of code does the feature require - in one of the Dockerfiles or startup scripts? Does it require new scripts entirely? Do users need - to adjust how they use the images? -- **Impact on image metrics**: 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? +- **Usefulness to Jupyter users**: + Is the feature generally applicable across domains? + Does it work with JupyterLab, Jupyter Notebook, JupyterHub, etc.? +- **Fit with the image purpose**: + Does the feature match the theme of the stack in which it will be added? + Would it fit better in a new community stack? +- **Complexity of build/runtime configuration**: + How many lines of code does the feature require in one of the Dockerfiles or startup scripts? + Does it require new scripts entirely? + Do users need to adjust how they use the images? +- **Impact on image metrics**: + 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 @@ -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: ```bash - make build/somestack-notebook + make build/-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.