Skip to content

Commit bf8efce

Browse files
committed
docs: add community health files
1 parent ffcd4e2 commit bf8efce

7 files changed

Lines changed: 193 additions & 0 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug report
3+
about: Report incorrect behavior in the OrgScript language, CLI, exporters, editor support, or docs
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
## Summary
10+
11+
Describe the bug clearly and briefly.
12+
13+
## Steps to reproduce
14+
15+
1.
16+
2.
17+
3.
18+
19+
## Expected behavior
20+
21+
What should have happened?
22+
23+
## Actual behavior
24+
25+
What happened instead?
26+
27+
## Reproduction input
28+
29+
If relevant, include:
30+
31+
- the `.orgs` file or a minimal snippet
32+
- the command you ran
33+
- the diagnostics or output you received
34+
35+
## Environment
36+
37+
- OrgScript version:
38+
- Node.js version:
39+
- OS:
40+
41+
## Additional context
42+
43+
Add any other context, screenshots, or notes here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: OrgScript contribution guide
4+
url: https://github.com/DKFuH/OrgScript/blob/main/CONTRIBUTING.md
5+
about: Read the contribution guidelines before proposing larger language or tooling changes.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Feature request
3+
about: Suggest an improvement to the language, tooling, docs, or ecosystem
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
## Summary
10+
11+
Describe the idea in one or two sentences.
12+
13+
## Problem
14+
15+
What problem does this solve?
16+
17+
## Proposed direction
18+
19+
Describe the smallest useful version of the idea.
20+
21+
## Why this fits OrgScript
22+
23+
Explain how the idea aligns with:
24+
25+
- clarity over cleverness
26+
- explicit semantics over shorthand
27+
- human readability and machine parseability
28+
- small, composable language growth
29+
30+
## Alternatives considered
31+
32+
What alternatives or workarounds exist today?
33+
34+
## Additional context
35+
36+
Add any examples, links, sketches, or prior discussion here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Description
2+
3+
Please include a summary of the change and any relevant issue links.
4+
5+
## Type of change
6+
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Documentation update
10+
- [ ] Refactor or maintenance change
11+
12+
## Validation
13+
14+
- [ ] I ran the relevant checks locally
15+
- [ ] I updated tests or fixtures where needed
16+
- [ ] I updated docs if the change affects user-facing behavior
17+
18+
## Notes
19+
20+
Anything reviewers should pay special attention to.

CODE_OF_CONDUCT.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Code of Conduct
2+
3+
OrgScript is committed to a respectful, constructive, and professional community.
4+
5+
## Our standards
6+
7+
Examples of behavior that help create a positive environment include:
8+
9+
- being respectful in language, tone, and intent
10+
- giving actionable, specific, and kind feedback
11+
- assuming good faith while still discussing tradeoffs honestly
12+
- welcoming people with different backgrounds, skill levels, and perspectives
13+
- focusing on what helps the language, tooling, and community move forward
14+
15+
Examples of unacceptable behavior include:
16+
17+
- harassment, intimidation, or personal attacks
18+
- hateful, discriminatory, or demeaning language
19+
- bad-faith arguments, trolling, or deliberate derailment
20+
- publishing other people's private information without permission
21+
- repeated dismissive or hostile behavior after being asked to stop
22+
23+
## Scope
24+
25+
This Code of Conduct applies in OrgScript spaces, including:
26+
27+
- GitHub issues
28+
- pull requests
29+
- discussions
30+
- release threads
31+
- other project communication channels managed by the maintainers
32+
33+
## Enforcement
34+
35+
Project maintainers may remove, edit, or reject comments, issues, pull requests, or other contributions that violate this Code of Conduct.
36+
37+
Maintainers may also take any action they consider appropriate, including temporary or permanent bans from project spaces.
38+
39+
## Reporting
40+
41+
If you experience or witness unacceptable behavior, please contact the maintainers through the repository owner contact listed on GitHub or via the project's published contact route.
42+
43+
When reporting, include:
44+
45+
- what happened
46+
- where it happened
47+
- links or screenshots if available
48+
- any relevant surrounding context
49+
50+
Reports will be reviewed as promptly and fairly as possible.
51+
52+
## Attribution
53+
54+
This Code of Conduct is informed by the Contributor Covenant spirit, adapted to fit OrgScript's project size and governance style.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,12 @@ npm run demo:generate
233233
- Language evolution: [docs/language-evolution.md](./docs/language-evolution.md)
234234
- Changelog: [CHANGELOG.md](./CHANGELOG.md)
235235

236+
## Community
237+
238+
- Contributing guide: [CONTRIBUTING.md](./CONTRIBUTING.md)
239+
- Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
240+
- Security policy: [SECURITY.md](./SECURITY.md)
241+
236242
## License
237243

238244
Apache-2.0

SECURITY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
OrgScript is still evolving quickly. In practice, the latest released version is the supported version for security fixes.
6+
7+
## Reporting a vulnerability
8+
9+
Please do not open a public GitHub issue for a suspected security vulnerability.
10+
11+
Instead, report it privately to the maintainer through the repository owner's GitHub contact route or the published repository contact information.
12+
13+
When possible, include:
14+
15+
- a short description of the issue
16+
- affected version or commit
17+
- steps to reproduce
18+
- expected impact
19+
- any suggested mitigation if known
20+
21+
We will review the report, reproduce it where possible, and determine the appropriate fix and disclosure path.
22+
23+
## Disclosure approach
24+
25+
OrgScript aims for responsible disclosure:
26+
27+
- acknowledge valid reports
28+
- work on a fix before broad public disclosure when practical
29+
- publish relevant release notes once a fix is available

0 commit comments

Comments
 (0)