From 41d2f26f9efdc16be46f5a27ee92f63861c8b438 Mon Sep 17 00:00:00 2001 From: Lane Sawyer Date: Fri, 8 Nov 2024 11:13:43 -0800 Subject: [PATCH 1/3] Add contributing and code of conduct documentation --- CODE_OF_CONDUCT.md | 116 ++++++++++++++++++++++++++ CONTRIBUTING.md | 146 +++++++++++++++++++++++++++++++++ LICENSE.md | 4 +- README.md | 4 +- examples/package.json | 2 +- packages/dzi/package.json | 2 +- packages/dzi/src/loader.ts | 16 ++-- packages/dzi/src/renderer.ts | 2 +- packages/geometry/package.json | 2 +- 9 files changed, 279 insertions(+), 15 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3a246ec --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,116 @@ +# Code of Conduct - Visualization Toolkit + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or + advances +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, +threatening, offensive, or harmful. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will +communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at . +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version +[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and +[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), +and was generated by [contributing-gen](https://github.com/bttger/contributing-gen). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7f40f4f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,146 @@ + + +# Contributing to Visualization Toolkit + +First off, thanks for taking the time to contribute! ❤️ + +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + + + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Your First Code Contribution](#your-first-code-contribution) + - [Improving The Documentation](#improving-the-documentation) +- [Styleguides](#styleguides) + - [Commit Messages](#commit-messages) +- [Join The Project Team](#join-the-project-team) + +## Code of Conduct + +This project and everyone participating in it is governed by the +[Visualization Toolkit Code of Conduct](https://github.com/AllenInstitute/visblob/master/CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report unacceptable behavior +to . + +## I Have a Question + +> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/AllenInstitute/vis/tree/main/docs). + +Before you ask a question, it is best to search for existing [Issues](https://github.com/AllenInstitute/vis/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. + +If you then still feel the need to ask a question and need clarification, we recommend the following: + +- Open an [Issue](https://github.com/AllenInstitute/vis/issues/new). +- Provide as much context as you can about what you're running into. +- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. + +We will then take care of the issue as soon as possible. + +## I Want To Contribute + +> ### Legal Notice +> +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + +### Reporting Bugs + + + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/AllenInstitute/vis/tree/main/docs). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/AllenInstitute/visissues?q=label%3Abug). +- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. +- Collect information about the bug: + - Stack trace (Traceback) + - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) + - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. + - Possibly your input and the output + - Can you reliably reproduce the issue? And can you also reproduce it with older versions? + + + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/AllenInstitute/vis/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Provide the information you collected in the previous section. + +Once it's filed: + +- The project team will label the issue accordingly. +- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. +- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for Visualization Toolkit, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + + + +#### Before Submitting an Enhancement + +- Make sure that you are using the latest version. +- Read the [documentation](https://github.com/AllenInstitute/vis/tree/main/docs) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/AllenInstitute/vis/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + + + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/AllenInstitute/vis/issues). + +- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. + +- **Explain why this enhancement would be useful** to most Visualization Toolkit users. You may also want to point out the other projects that solved it better and which could serve as inspiration. + +### Your First Code Contribution + +If you have a recent version of Node and a code editor, you should be able to run the examples and get started on new development without much hassle! See the documentation for further details on running examples or getting started with development. + +### Improving The Documentation + +Documentation improvements are incredibly helpful and welcome. At the moment, we use markdown files on the `docs` folder to document key pieces of the project. At some point we would like to move to a more structured documentation system, but for now, markdown is the way to go when creating new documentation. + +## Styleguides + +### Linting and Formatting + +We use a linter and code formatter on the project and check for errors. That will largely keep the code style consistent. Make sure to run those checks and fix any issues when opening a PR! + +### Commit Messages + +We strive to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. This convention makes it easier to understand the changes in a project and to automate the versioning process. + +You do not need to make every commit a conventional commit, as we squash and merge PRs into a single commit. At that point, one of the maintainers will write a proper commit message. But if you already have one written in that format, that helps us out! + + + +## Attribution + +This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! diff --git a/LICENSE.md b/LICENSE.md index 0745566..45200b7 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright 2024 Allen Institute +Copyright 2024 Allen Institute Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -8,4 +8,4 @@ Redistribution and use in source and binary forms, with or without modification, 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index a9a0ba7..a1ea439 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ For details on running or adding new examples, see the `docs/examples.md` file. # Contributing -Contributions are welcome! We're currently breaking apart the Scattebrain component into smaller, more manageable packages. If you have a package that you think would be useful to others, please open a PR. +Contributions are welcome! We're currently breaking apart the Scatterbrain component into smaller, more manageable packages. If you have a package that you think would be useful to others, please open a PR. + +See the CONTRIBUTING.md file for more information on how to contribute to the project # Using the Libraries diff --git a/examples/package.json b/examples/package.json index fb913ea..19aa863 100644 --- a/examples/package.json +++ b/examples/package.json @@ -64,4 +64,4 @@ "regl": "^2.1.0", "zarrita": "0.4.0-next.14" } -} \ No newline at end of file +} diff --git a/packages/dzi/package.json b/packages/dzi/package.json index dd7e021..dfdc05b 100644 --- a/packages/dzi/package.json +++ b/packages/dzi/package.json @@ -55,4 +55,4 @@ "lodash": "^4.17.21", "regl": "^2.1.0" } -} \ No newline at end of file +} diff --git a/packages/dzi/src/loader.ts b/packages/dzi/src/loader.ts index 0edda84..1ebb9b3 100644 --- a/packages/dzi/src/loader.ts +++ b/packages/dzi/src/loader.ts @@ -54,13 +54,13 @@ export function getVisibleTiles(dzi: DziImage, camera: { view: box2D; screenSize const availableTiles = tilesInLayer(dzi, layer); const baseLayer = findLargestSingleTileLayer(dzi); - const baseIndex: TileIndex = { col: 0, row: 0 } + const baseIndex: TileIndex = { col: 0, row: 0 }; const baseTile: DziTile = { index: baseIndex, layer: baseLayer, relativeLocation: Box2D.create([0, 0], [1, 1]), - url: tileUrl(dzi, baseLayer, baseIndex) - } + url: tileUrl(dzi, baseLayer, baseIndex), + }; // note that the tile boxes are in pixels relative to the layer in which they reside // the given view is assumed to be a parameter (in the space [0:1]) of the image as a whole @@ -82,7 +82,7 @@ export function getVisibleTiles(dzi: DziImage, camera: { view: box2D; screenSize // filter out tiles which are not in view }) .filter((t) => !!Box2D.intersection(t.relativeLocation, camera.view)); - return (baseLayer < layer) ? [baseTile, ...tiles] : tiles; + return baseLayer < layer ? [baseTile, ...tiles] : tiles; } /** * NOTE: THE REMAINDER OF THIS FILE IS EXPORTED ONLY FOR TESTING PURPOSES @@ -97,13 +97,13 @@ export function firstSuitableLayer(imageWidth: number, screenWidth: number) { } /** - * - * @param dzi + * + * @param dzi * @returns the index of the largest layer which contains only a single tile - * + * */ function findLargestSingleTileLayer(dzi: DziImage): number { - return Math.floor(Math.log2(dzi.tileSize)) + return Math.floor(Math.log2(dzi.tileSize)); } export function tileWithOverlap(total: number, step: number, overlap: number): Interval[] { const blocks: Interval[] = []; diff --git a/packages/dzi/src/renderer.ts b/packages/dzi/src/renderer.ts index 4962a41..1937ad0 100644 --- a/packages/dzi/src/renderer.ts +++ b/packages/dzi/src/renderer.ts @@ -45,7 +45,7 @@ export function buildDziRenderer(regl: REGL.Regl): Renderer { }, // no private resources to destroy + destroy: () => {}, // no private resources to destroy cacheKey: (item, _requestKey, _data, _settings) => `${item.url}`, fetchItemContent: fetchDziTile, getVisibleItems: (dzi, settings) => { diff --git a/packages/geometry/package.json b/packages/geometry/package.json index f7ed500..00783d6 100644 --- a/packages/geometry/package.json +++ b/packages/geometry/package.json @@ -52,4 +52,4 @@ "typescript": "^5.3.3", "vitest": "^1.4.0" } -} \ No newline at end of file +} From b4fdefae328f2ac1982743a8207aaeda8a9409c1 Mon Sep 17 00:00:00 2001 From: Lane Sawyer Date: Tue, 12 Nov 2024 13:03:51 -0800 Subject: [PATCH 2/3] fmt --- packages/scatterbrain/package.json | 2 +- packages/scatterbrain/src/abstract/async-frame.ts | 8 ++++---- packages/scatterbrain/src/abstract/render-server.ts | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/scatterbrain/package.json b/packages/scatterbrain/package.json index 07935cd..5376029 100644 --- a/packages/scatterbrain/package.json +++ b/packages/scatterbrain/package.json @@ -58,4 +58,4 @@ "lodash": "^4.17.21", "regl": "^2.1.0" } -} \ No newline at end of file +} diff --git a/packages/scatterbrain/src/abstract/async-frame.ts b/packages/scatterbrain/src/abstract/async-frame.ts index a2e0eb3..ea32ba4 100644 --- a/packages/scatterbrain/src/abstract/async-frame.ts +++ b/packages/scatterbrain/src/abstract/async-frame.ts @@ -102,7 +102,7 @@ export function beginFrame< if (synchronous) { lifecycleCallback(event); } else { - Promise.resolve().then(() => lifecycleCallback(event)) + Promise.resolve().then(() => lifecycleCallback(event)); } }; @@ -158,10 +158,10 @@ export function beginFrame< } }; - reportStatus({ status: 'begin' }, true) + reportStatus({ status: 'begin' }, true); const interval = setInterval(() => doWorkOnQueue(interval), queueProcessingIntervalMS); if (queue.length > 0) { - doWorkOnQueue(interval, false) + doWorkOnQueue(interval, false); } return { cancelFrame: (reason?: string) => { @@ -169,7 +169,7 @@ export function beginFrame< abort.abort(new DOMException(reason, 'AbortError')); clearInterval(interval); reportStatus({ status: 'cancelled' }, true); - } + }, }; } diff --git a/packages/scatterbrain/src/abstract/render-server.ts b/packages/scatterbrain/src/abstract/render-server.ts index 664b538..2bf3b32 100644 --- a/packages/scatterbrain/src/abstract/render-server.ts +++ b/packages/scatterbrain/src/abstract/render-server.ts @@ -179,7 +179,7 @@ export class RenderServer { // this is a good thing for performance, but potentially confusing - so we do our book-keeping before we actually start rendering: const aboutToStart = this.clients.get(client); // this is the record we just put into the clients map - TS just wants to be sure it really exists: if (aboutToStart) { - aboutToStart.frame = renderFn(image, this.cache, hijack) + aboutToStart.frame = renderFn(image, this.cache, hijack); } } } From a89b46c64792191a698942b2a2bcda0f781e0920 Mon Sep 17 00:00:00 2001 From: Lane Sawyer Date: Wed, 20 Nov 2024 15:25:54 -0800 Subject: [PATCH 3/3] PR feedback: grammar, add veterans to protected status, and a sentence for no retaliation policy --- CODE_OF_CONDUCT.md | 4 ++-- CONTRIBUTING.md | 9 ++++----- README.md | 2 +- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 3a246ec..75278a1 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,7 +6,7 @@ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal +level of experience, education, socio-economic status, nationality, veteran status, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards @@ -60,7 +60,7 @@ reported to the community leaders responsible for enforcement at