Skip to content

Commit a92f225

Browse files
committed
Add code of conduct
1 parent a34ccbd commit a92f225

4 files changed

Lines changed: 83 additions & 16 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
FEAScript is both a software project and a community. We are committed to providing a friendly, safe, welcoming, and inclusive environment for everyone, regardless of experience level, gender identity or expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other personal characteristic.
6+
7+
We value the different perspectives that make open source projects stronger. Technical disagreement is normal and welcome when it is expressed professionally and constructively.
8+
9+
## Scope
10+
11+
This Code of Conduct applies to all project participants, including contributors, users, maintainers, sponsors, and affiliated members. It applies in all FEAScript community spaces, including GitHub repositories, issues, pull requests, discussions, project websites, social media, events, and private communications related to the project.
12+
13+
It also applies when an individual represents FEAScript in public spaces, such as through an official project account or at an online or in-person event. Behavior outside these spaces may be addressed when it has the potential to adversely affect the safety or well-being of community members.
14+
15+
## Expected Behavior
16+
17+
When participating in this community, please:
18+
19+
- Be respectful, considerate, and constructive
20+
- Welcome different perspectives and experiences
21+
- Assume positive intent and seek to understand before responding
22+
- Give and accept feedback in good faith
23+
- Communicate plainly and carefully, especially during disagreements
24+
- Be patient and kind to new contributors and beginners
25+
- Focus on what is best for the community and its projects
26+
- Respect personal boundaries and privacy
27+
28+
## Unacceptable Behavior
29+
30+
The following behavior is not acceptable:
31+
32+
- Harassment, discrimination, bullying, intimidation, or personal attacks
33+
- Harmful or prejudicial comments about a person's identity, background, ability, or other personal characteristics
34+
- Unwelcome sexual attention, sexualized language or imagery, or unwanted physical or simulated contact
35+
- Threats of violence, stalking, doxxing, or sharing private information without permission
36+
- Deliberate misgendering or outing of a person's identity without consent
37+
- Trolling, sustained disruption, or bad-faith participation in project discussions
38+
- Any conduct that could reasonably be considered inappropriate in a professional setting
39+
40+
Do not escalate conflicts in public forums. Report incidents to the maintainers instead of engaging in retaliation or prolonged personal disputes.
41+
42+
## Engineering Responsibility
43+
44+
FEAScript is used to build engineering simulations, and the results people obtain with it can inform real decisions. In the spirit of the Archimedean Oath, we ask contributors to:
45+
46+
- Develop and share this technology for the benefit of people and the natural environment
47+
- Consider the wider impact of the work and avoid contributing toward harmful goals
48+
- Be honest about the assumptions, limitations, and accuracy of methods and results
49+
- Keep growing as problem solvers, and help others in the community do the same
50+
51+
## Maintainer Responsibilities
52+
53+
Maintainers are responsible for clarifying these standards and taking appropriate, fair corrective action when unacceptable behavior occurs. Maintainers are held to the same Code of Conduct as all other participants.
54+
55+
## Reporting
56+
57+
If you experience or witness unacceptable behavior, please contact the project maintainers through a private GitHub message or another private project communication channel. Include the names or usernames of those involved, an account of what occurred, relevant links or records, and any other information that may help us review the report.
58+
59+
Reports will be handled with discretion and as confidentially as possible. A maintainer who is involved in a report will not handle it. All reports will be reviewed and receive a response appropriate to the circumstances.
60+
61+
## Enforcement
62+
63+
Maintainers may remove, edit, or reject contributions; issue warnings; temporarily restrict participation; or permanently remove access when behavior violates this Code of Conduct. Decisions will be made in good faith and in proportion to the circumstances.
64+
65+
## Changes
66+
67+
This is a living document and may be updated as the FEAScript community evolves.
68+
69+
## Attribution
70+
71+
This Code of Conduct borrows heavily from the [stdlib Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md), the [Open Code of Conduct](https://github.com/todogroup/opencodeofconduct/blob/gh-pages/codeofconduct_redo.md), and the [Linux Kernel Code of Conduct](https://docs.kernel.org/process/code-of-conduct.html). The Engineering Responsibility section is inspired by the [Archimedean Oath](https://www.ilry.fi/en/students/graduation/oath-archimedes/).

CONTRIBUTING.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributing to FEAScript
1+
# Contributing to FEAScript
22

33
Thank you for your interest in contributing! FEAScript is in early development, with continuous additions of new features and improvements. To ensure a smooth and collaborative development process, please review and follow the guidelines below.
44

@@ -100,11 +100,7 @@ External contributors:
100100
Before submitting a pull request, test your modifications by running the FEAScript library from a local directory. For example, you can load the library in your HTML file as follows:
101101

102102
```javascript
103-
import {
104-
FEAScriptModel,
105-
plotSolution,
106-
printVersion,
107-
} from "[USER_DIRECTORY]/FEAScript-core/src/index.js";
103+
import { FEAScriptModel, plotSolution, printVersion } from "[USER_DIRECTORY]/FEAScript-core/src/index.js";
108104
```
109105

110106
FEAScript can be run on a local server. You **must** start the server from the workspace root directory (the folder that contains both `FEAScript-core/` and `FEAScript-website/`), not from inside either subfolder. The HTML files use relative paths such as `../feascript-website.css` and `../../FEAScript-core/src/index.js` that only resolve correctly from that root.

CONTRIBUTORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributors
1+
# Contributors
22

33
(alphabetical order)
44

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ style="vertical-align: middle; margin-right: 5px; height: 1em; width: auto"
1919

2020
> 🚧 **FEAScript is currently under heavy development.** Its functionality and interfaces may change rapidly as new features and enhancements are introduced. <a href="https://github.com/sponsors/FEAScript">Donations</a> help accelerate the next generation of FEAScript's solvers, performance, documentation and tutorials.
2121
22+
## Contents
23+
24+
- [Features](#features)
25+
- [How to Use FEAScript](#how-to-use-feascript)
26+
- [Examples](#examples)
27+
- [Help FEAScript Grow](#help-feascript-grow)
28+
- [Contributing](#contributing)
29+
- [License](#license)
30+
2231
## Features
2332

2433
- <b>Physics models:</b> creeping (Stokes) flow, Euler-Bernoulli beam bending, front propagation, heat conduction, general form PDE (linear and nonlinear)
@@ -28,15 +37,6 @@ style="vertical-align: middle; margin-right: 5px; height: 1em; width: auto"
2837
- <b>Performance:</b> web worker support for multi-threaded computation
2938
- <b>Visualization:</b> interactive rendering with vtk.js and Plotly
3039

31-
<!-- ## Contents
32-
33-
- [How to Use FEAScript](#ways-to-use-feascript)
34-
- [Features](#features)
35-
- [Examples](#examples)
36-
- [Support FEAScript](#support-feascript)
37-
- [Contributing](#contributing)
38-
- [License](#license) -->
39-
4040
## How to Use FEAScript
4141

4242
You can run simulations with FEAScript by calling its functions from JavaScript (the FEAScript API). The API is the core programmatic interface for FEAScript and works across multiple environments, including the browser (simple HTML pages and online JavaScript playgrounds, e.g. [CodePen](https://codepen.io/) and [Scribbler](https://scribbler.live/)) and server-side runtimes such as Node.js. The most common ways to use FEAScript are outlined below:

0 commit comments

Comments
 (0)