Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 6 additions & 123 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,128 +1,11 @@
# Contributor Covenant Code of Conduct
# Code of Conduct

## Our Pledge
Be respectful and use common sense when participating in this project.

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible 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.
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.

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

## Our Standards
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.

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 of any kind
* 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

## Enforcement Responsibilities

Community leaders 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.

Community leaders 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
vanruesc@outlook.de.
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][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
If you encounter behaviour that you believe should be addressed, contact the project maintainers at [vanruesc@outlook.de](mailto:vanruesc@outlook.de).
72 changes: 25 additions & 47 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,44 @@
# Contributing

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

## Before you start

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

1. Search the issue tracker for similar bug reports before submitting a new one.
2. Specify the version of the library where the bug occurred.
3. Specify your browser version, operating system, and graphics card manufacturer
(e.g. `Chrome, Windows, NVIDIA`).
4. Describe the problem in detail. Explain what happened, and what you expected would happen.
5. Provide a minimal test case (http://jsfiddle.net) or a link to a live version of your application.
6. If applicable, include a screenshot. Consider annotating the screenshot for clarity.
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.

## Development

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

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

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

## Testing

### Development :wrench:
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.

This project contains scripts that will help you during development. All scripts can be executed with `npm run [script]`.
The following table provides an overview of the most important scripts:
> [!NOTE]
> Tests rely on the built bundle and require `pnpm build:js` after source changes.

| Task | Description |
|-------|---------------------------------------------------------------------------------|
| build | Builds and minifies all bundles. |
| watch | Lints sources, builds the manual, listens for changes and serves files locally. |
| test | Lints source files, builds all bundles and runs unit tests. |
Manually verify affected demos or visual behaviour where practical.

## Pull requests

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

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.
Keep the branch up to date with `dev` if you encounter merge conflicts.

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

Search the issue tracker before opening a new report.

### Keeping Things Up-To-Date :hourglass:

Don't merge new changes from upstream into your feature branch.
Instead, use `rebase` to replay all of your commits on top of the latest code base:

```sh
git checkout main
git pull upstream main
git checkout my-feature
git rebase main
```

Git will guide you through the process of resolving conflicts.
This operation is similar to merging, except you're in fact rewriting your local history.
After rebasing, you'll need to use `git push --force my-feature`.

You can add more commits to your feature branch after you created the Pull Request.
This means that you can change things later if necessary.
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.
44 changes: 13 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,23 @@ labels: ''
assignees: ''
---

### Description of the bug
## What happened?

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

## Reproduction

### To reproduce
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.

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
## Environment

* Three.js:
* Postprocessing:
* Browser:
* OS:
* Graphics hardware: <!-- if relevant -->
* Device: <!-- if relevant -->

### Expected behavior
## Additional context

A clear and concise description of what you expected to happen.


### Screenshots

If applicable, add screenshots to help explain your problem.


### Library versions used

- Three: [e.g. X.XXX.X]
- Post Processing: [e.g. X.X.X]


### Desktop

- OS: [e.g. Windows]
- Browser [e.g. Chrome X.X.X.X]
- Graphics hardware: [e.g. NVIDIA]


### Mobile

- Device: [e.g. iPhone]
- OS: [e.g. Android]
- Browser [e.g. Firefox X.X.X]
Add screenshots, error messages, or anything else that might help diagnose the issue.
20 changes: 3 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,10 @@ about: Suggest an idea for this project
title: ''
labels: feature request
assignees: ''

---

### Is your feature request related to a problem?

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]


### Describe the solution you'd like

A clear and concise description of what you want to happen.


### Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

## What would you like to see?

### Additional context
Describe the feature or improvement you'd like.

Add any other context or screenshots about the feature request here.
Include any relevant context, examples, or alternatives that might help us understand the request.
8 changes: 8 additions & 0 deletions .github/dependabot.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Set update schedule for GitHub Actions
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
# Check for updates to GitHub Actions every week
interval: "weekly"
35 changes: 17 additions & 18 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,25 @@ jobs:
name: Deploy
runs-on: ubuntu-latest
steps:
- name: Git checkout
uses: actions/checkout@v5
- name: Install PNPM
uses: pnpm/action-setup@v4
- uses: actions/checkout@v7
- name: Install pnpm and Node.js
uses: pnpm/setup@v2
with:
version: 10
- name: Install Node
uses: actions/setup-node@v6
with:
node-version: 24
registry-url: "https://registry.npmjs.org"
cache: "pnpm"
- name: Install dependencies and test
run: pnpm install-test --frozen-lockfile
version: 11
runtime: node@24
cache: true
- name: Build and test
run: pnpm test
- name: Publish
uses: JS-DevTools/npm-publish@v4
with:
provenance: true
ignore-scripts: true
- name: Pages
run: |
package=$(node -p "require('./package.json').name")
version=$(node -p "require('./package.json').version")
if pnpm view "$package@$version" version >/dev/null 2>&1; then
echo "::notice::$package@$version is already published, skipping."
exit 0
fi
pnpm publish --ignore-scripts
- name: Deploy pages
run: pnpm run deploy
- uses: JamesIves/github-pages-deploy-action@v4
with:
Expand Down
20 changes: 8 additions & 12 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,12 @@ jobs:
name: Test
runs-on: ubuntu-latest
steps:
- name: Git checkout
uses: actions/checkout@v5
- name: Install PNPM
uses: pnpm/action-setup@v4
- uses: actions/checkout@v7
- name: Install pnpm and Node.js
uses: pnpm/setup@v2
with:
version: 10
- name: Install Node
uses: actions/setup-node@v6
with:
node-version: 24
cache: "pnpm"
- name: Install and test
run: pnpm install-test --frozen-lockfile
version: 11
runtime: node@24
cache: true
- name: Build and test
run: pnpm test
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,8 @@ pagefind/
*.lock
*.log
*.tmp

# Playwright
test-results/
playwright-report/
blob-report/
Loading