Skip to content

Commit c11625f

Browse files
committed
Backport changes from v7
1 parent 03cbe76 commit c11625f

11 files changed

Lines changed: 108 additions & 259 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 6 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,11 @@
1-
# Contributor Covenant Code of Conduct
1+
# Code of Conduct
22

3-
## Our Pledge
3+
Be respectful and use common sense when participating in this project.
44

5-
We as members, contributors, and leaders pledge to make participation in our
6-
community a harassment-free experience for everyone, regardless of age, body
7-
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, religion, or sexual identity
10-
and orientation.
5+
Contributions, discussions, and interactions should be constructive and focused on the project. Harassment, personal attacks, threats, discrimination, deliberate disruption, publishing private information, and other abusive behaviour are not welcome.
116

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
7+
Disagreements are fine. Criticism and strong opinions are fine too. Keep discussions about the work rather than the people involved.
148

15-
## Our Standards
9+
If someone repeatedly or seriously crosses the line, they may be removed or blocked from the project and its community spaces. There is no formal enforcement process or required sequence of warnings; moderation decisions are made at the discretion of the project maintainers.
1610

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
19-
20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
26-
overall community
27-
28-
Examples of unacceptable behavior include:
29-
30-
* The use of sexualized language or imagery, and sexual attention or
31-
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
38-
39-
## Enforcement Responsibilities
40-
41-
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
44-
or harmful.
45-
46-
Community leaders have the right and responsibility to remove, edit, or reject
47-
comments, commits, code, wiki edits, issues, and other contributions that are
48-
not aligned to this Code of Conduct, and will communicate reasons for moderation
49-
decisions when appropriate.
50-
51-
## Scope
52-
53-
This Code of Conduct applies within all community spaces, and also applies when
54-
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
58-
59-
## Enforcement
60-
61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
64-
All complaints will be reviewed and investigated promptly and fairly.
65-
66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
68-
69-
## Enforcement Guidelines
70-
71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
73-
74-
### 1. Correction
75-
76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
78-
79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
82-
83-
### 2. Warning
84-
85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
87-
88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or
93-
permanent ban.
94-
95-
### 3. Temporary Ban
96-
97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
99-
100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
105-
106-
### 4. Permanent Ban
107-
108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
111-
112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
114-
115-
## Attribution
116-
117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120-
121-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122-
enforcement ladder](https://github.com/mozilla/diversity).
123-
124-
[homepage]: https://www.contributor-covenant.org
125-
126-
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
11+
If you encounter behaviour that you believe should be addressed, contact the project maintainers at [[email protected]](mailto:[email protected]).

‎.github/CONTRIBUTING.md‎

Lines changed: 25 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,44 @@
11
# Contributing
22

3-
Thank you for considering to contribute! :speech_balloon:
3+
Thanks for contributing! This document covers the development workflow and conventions for working on the project.
44

5+
## Before you start
56

6-
## Bugs :bug:
7+
For substantial changes, open an issue first to discuss the approach. Keep changes focused and avoid unrelated refactoring.
78

8-
1. Search the issue tracker for similar bug reports before submitting a new one.
9-
2. Specify the version of the library where the bug occurred.
10-
3. Specify your browser version, operating system, and graphics card manufacturer
11-
(e.g. `Chrome, Windows, NVIDIA`).
12-
4. Describe the problem in detail. Explain what happened, and what you expected would happen.
13-
5. Provide a minimal test case (http://jsfiddle.net) or a link to a live version of your application.
14-
6. If applicable, include a screenshot. Consider annotating the screenshot for clarity.
9+
Follow existing project patterns, abstractions, formatting, and naming conventions. Prefer small, focused changes over new infrastructure or abstractions. New classes and class members should include appropriate documentation comments.
1510

11+
## Development
1612

17-
## Pull Request Process :sparkles:
13+
Use **pnpm** and the scripts defined in `package.json`. Use `pnpm format` to apply ESLint fixes and `pnpm lint` to check the code.
1814

19-
When contributing to this repository, please first discuss the changes you wish to make with the owners of this repository via the issue tracker.
20-
A proposed change should be focused and concise. Please adhere to the following guideline:
15+
### Recommended VSCode plugins
2116

22-
1. Create a feature branch based on the `dev` branch.
23-
2. Implement your patch or feature on that branch.
24-
3. Lint and test your changes. Maintain the existing coding style.
25-
4. Add unit tests for any new or changed functionality.
26-
5. Navigate to your fork on Github, select your feature branch and create a new Pull Request targeting the `dev` branch.
27-
6. Once your PR has been merged, you can safely remove your feature-branch.
17+
* [ESLint](https://open-vsx.org/extension/dbaeumer/vscode-eslint)
18+
* [Shader languages support](https://open-vsx.org/extension/slevesque/shader)
19+
* [Hugo Language and Syntax Support](https://open-vsx.org/extension/budparr/language-hugo-vscode) (when working on the manual)
2820

21+
## Testing
2922

30-
### Development :wrench:
23+
Add or update tests for changed functionality. During development, use the most targeted test command available such as `pnpm test:unit` for quick iteration. Run the full `pnpm test` for final verification before opening a pull request.
3124

32-
This project contains scripts that will help you during development. All scripts can be executed with `npm run [script]`.
33-
The following table provides an overview of the most important scripts:
25+
> [!NOTE]
26+
> Tests rely on the built bundle and require `pnpm build:js` after source changes.
3427
35-
| Task | Description |
36-
|-------|---------------------------------------------------------------------------------|
37-
| build | Builds and minifies all bundles. |
38-
| watch | Lints sources, builds the manual, listens for changes and serves files locally. |
39-
| test | Lints source files, builds all bundles and runs unit tests. |
28+
Manually verify affected demos or visual behaviour where practical.
4029

30+
## Pull requests
4131

42-
### Testing :heavy_check_mark:
32+
1. Create a branch from the current `dev` branch.
33+
2. Make the smallest focused change that solves the problem.
34+
3. Add or update tests and documentation as appropriate.
35+
4. Run the relevant checks and final test suite.
36+
5. Open a pull request targeting `dev`, describing what changed and why.
4337

44-
Use the script `npm run watch` to run an HTTP server, build the demo bundle and watch files for changes. Open your web browser and navigate to http://localhost:1313. Extend one of the existing demos or create a new one depending on the kind of feature you wish to implement. Make sure that your changes don't break the existing demos.
38+
Keep the branch up to date with `dev` if you encounter merge conflicts.
4539

46-
__Hint__: Open the development tools in your browser and make sure that the cache is disabled while it's open.
40+
## Reporting bugs
4741

42+
Search the issue tracker before opening a new report.
4843

49-
### Keeping Things Up-To-Date :hourglass:
50-
51-
Don't merge new changes from upstream into your feature branch.
52-
Instead, use `rebase` to replay all of your commits on top of the latest code base:
53-
54-
```sh
55-
git checkout main
56-
git pull upstream main
57-
git checkout my-feature
58-
git rebase main
59-
```
60-
61-
Git will guide you through the process of resolving conflicts.
62-
This operation is similar to merging, except you're in fact rewriting your local history.
63-
After rebasing, you'll need to use `git push --force my-feature`.
64-
65-
You can add more commits to your feature branch after you created the Pull Request.
66-
This means that you can change things later if necessary.
44+
Include the affected library version, browser and OS versions, a clear description and expected behaviour, and a minimal reproducible example. Include graphics hardware and screenshots or other diagnostics when relevant.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,23 @@ labels: ''
66
assignees: ''
77
---
88

9-
### Description of the bug
9+
## What happened?
1010

11-
A clear and concise description of what the bug is.
11+
Describe the problem, including what you expected to happen.
1212

13+
## Reproduction
1314

14-
### To reproduce
15+
Provide the steps and a minimal example that reproduces the issue. You can use the [demo sandbox](https://stackblitz.com/edit/postprocessing) as a starting point.
1516

16-
Describe the steps to reproduce the behavior and provide a minimal example that demonstrates the issue. You can use the demo sandbox as a starting point: https://stackblitz.com/edit/postprocessing-v6
17+
## Environment
1718

19+
* Three.js:
20+
* Postprocessing:
21+
* Browser:
22+
* OS:
23+
* Graphics hardware: <!-- if relevant -->
24+
* Device: <!-- if relevant -->
1825

19-
### Expected behavior
26+
## Additional context
2027

21-
A clear and concise description of what you expected to happen.
22-
23-
24-
### Screenshots
25-
26-
If applicable, add screenshots to help explain your problem.
27-
28-
29-
### Library versions used
30-
31-
- Three: [e.g. X.XXX.X]
32-
- Post Processing: [e.g. X.X.X]
33-
34-
35-
### Desktop
36-
37-
- OS: [e.g. Windows]
38-
- Browser [e.g. Chrome X.X.X.X]
39-
- Graphics hardware: [e.g. NVIDIA]
40-
41-
42-
### Mobile
43-
44-
- Device: [e.g. iPhone]
45-
- OS: [e.g. Android]
46-
- Browser [e.g. Firefox X.X.X]
28+
Add screenshots, error messages, or anything else that might help diagnose the issue.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,10 @@ about: Suggest an idea for this project
44
title: ''
55
labels: feature request
66
assignees: ''
7-
87
---
98

10-
### Is your feature request related to a problem?
11-
12-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13-
14-
15-
### Describe the solution you'd like
16-
17-
A clear and concise description of what you want to happen.
18-
19-
20-
### Describe alternatives you've considered
21-
22-
A clear and concise description of any alternative solutions or features you've considered.
23-
9+
## What would you like to see?
2410

25-
### Additional context
11+
Describe the feature or improvement you'd like.
2612

27-
Add any other context or screenshots about the feature request here.
13+
Include any relevant context, examples, or alternatives that might help us understand the request.

‎.github/dependabot.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Set update schedule for GitHub Actions
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
# Check for updates to GitHub Actions every week
8+
interval: "weekly"

‎.github/workflows/cd.yml‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,25 @@ jobs:
1515
name: Deploy
1616
runs-on: ubuntu-latest
1717
steps:
18-
- name: Git checkout
19-
uses: actions/checkout@v5
20-
- name: Install PNPM
21-
uses: pnpm/action-setup@v4
18+
- uses: actions/checkout@v7
19+
- name: Install pnpm and Node.js
20+
uses: pnpm/setup@v2
2221
with:
23-
version: 10
24-
- name: Install Node
25-
uses: actions/setup-node@v6
26-
with:
27-
node-version: 24
28-
registry-url: "https://registry.npmjs.org"
29-
cache: "pnpm"
30-
- name: Install dependencies and test
31-
run: pnpm install-test --frozen-lockfile
22+
version: 11
23+
runtime: node@24
24+
cache: true
25+
- name: Build and test
26+
run: pnpm test
3227
- name: Publish
33-
uses: JS-DevTools/npm-publish@v4
34-
with:
35-
provenance: true
36-
ignore-scripts: true
37-
- name: Pages
28+
run: |
29+
package=$(node -p "require('./package.json').name")
30+
version=$(node -p "require('./package.json').version")
31+
if pnpm view "$package@$version" version >/dev/null 2>&1; then
32+
echo "::notice::$package@$version is already published, skipping."
33+
exit 0
34+
fi
35+
pnpm publish --ignore-scripts
36+
- name: Deploy pages
3837
run: pnpm run deploy
3938
- uses: JamesIves/github-pages-deploy-action@v4
4039
with:

‎.github/workflows/ci.yml‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,12 @@ jobs:
1111
name: Test
1212
runs-on: ubuntu-latest
1313
steps:
14-
- name: Git checkout
15-
uses: actions/checkout@v5
16-
- name: Install PNPM
17-
uses: pnpm/action-setup@v4
14+
- uses: actions/checkout@v7
15+
- name: Install pnpm and Node.js
16+
uses: pnpm/setup@v2
1817
with:
19-
version: 10
20-
- name: Install Node
21-
uses: actions/setup-node@v6
22-
with:
23-
node-version: 24
24-
cache: "pnpm"
25-
- name: Install and test
26-
run: pnpm install-test --frozen-lockfile
18+
version: 11
19+
runtime: node@24
20+
cache: true
21+
- name: Build and test
22+
run: pnpm test

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,8 @@ pagefind/
4141
*.lock
4242
*.log
4343
*.tmp
44+
45+
# Playwright
46+
test-results/
47+
playwright-report/
48+
blob-report/

0 commit comments

Comments
 (0)