Skip to content

Commit 8293215

Browse files
alpha912alpha912
committed
docs: Add CODE_OF_CONDUCT, CONTRIBUTING
- Adds required community files - Provides contribution guidelines for examples
1 parent 69215aa commit 8293215

File tree

3 files changed

+251
-1
lines changed

3 files changed

+251
-1
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
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 and
10+
orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
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 overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
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 address,
35+
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+
**[alphinctom@gmail.com](mailto:alphinctom@gmail.com)**. All complaints will be
64+
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 of
86+
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 permanent
93+
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 the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the
118+
[Contributor Covenant](https://www.contributor-covenant.org), version 2.1,
119+
available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
124+
125+
For answers to common questions about this code of conduct, see
126+
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).

‎CONTRIBUTING.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Contributing to OmniScript Examples
2+
3+
Thank you for your interest in contributing examples to **OmniScript Format (OSF)**! This repository contains professional examples and templates.
4+
5+
---
6+
7+
## 🚀 Getting Started
8+
9+
### 1️⃣ Fork the repository
10+
11+
Click the **Fork** button at the top right of the [omniscript-examples](https://github.com/OmniScriptOSF/omniscript-examples) repository page.
12+
13+
### 2️⃣ Clone your fork locally
14+
15+
```bash
16+
git clone https://github.com/your-username/omniscript-examples.git
17+
cd omniscript-examples
18+
git checkout -b my-example-branch
19+
```
20+
21+
### 3️⃣ Install dependencies
22+
23+
```bash
24+
npm install
25+
```
26+
27+
### 4️⃣ Create your example
28+
29+
- Place your example in the appropriate category folder
30+
- Use descriptive filenames (kebab-case: `my-example.osf`)
31+
- Add a header comment explaining the example
32+
- Use realistic content, not lorem ipsum
33+
- Ensure your example parses successfully
34+
35+
### 5️⃣ Validate your example
36+
37+
```bash
38+
# Validate all examples
39+
npm run validate
40+
41+
# Or validate a specific file
42+
npm run validate:file your-example.osf
43+
```
44+
45+
### 6️⃣ Commit and push
46+
47+
```bash
48+
git add .
49+
git commit -m "Add: [Category] - [Example Name]"
50+
git push origin my-example-branch
51+
```
52+
53+
### 7️⃣ Open a Pull Request
54+
55+
Go to your fork on GitHub and click **Compare & pull request**.
56+
57+
---
58+
59+
## 💡 Example Guidelines
60+
61+
### File Naming
62+
- Use kebab-case: `business-report.osf`
63+
- Be descriptive: `quarterly-sales-report.osf` not `report.osf`
64+
65+
### Header Comment
66+
```osf
67+
// =============================================================================
68+
// Example: Quarterly Sales Report
69+
// Category: Business
70+
// Description: Comprehensive sales report with charts and tables
71+
// Features: @doc, @table, @chart, @slide
72+
// Estimated time: 15 minutes
73+
// =============================================================================
74+
```
75+
76+
### Content Quality
77+
- ✅ Use realistic, meaningful content
78+
- ✅ Demonstrate specific OSF features
79+
- ✅ Include inline comments for complex syntax
80+
- ✅ Ensure document parses without errors
81+
- ❌ No lorem ipsum or placeholder text
82+
83+
### Categories
84+
- `getting-started/` - Simple examples for beginners
85+
- `documents/` - Document examples
86+
- `presentations/` - Presentation examples
87+
- `spreadsheets/` - Spreadsheet examples
88+
- `combined/` - Multi-format examples
89+
- `advanced/` - Complex examples
90+
- `use-cases/` - Real-world scenarios
91+
92+
---
93+
94+
## ✨ Guidelines
95+
96+
### Commit Message Convention
97+
98+
- `Add:` - New example
99+
- `Update:` - Modify existing example
100+
- `Fix:` - Fix errors in example
101+
- `Docs:` - Update README or documentation
102+
103+
**Examples:**
104+
```
105+
Add: [Business] - Quarterly Review Presentation
106+
Update: [Getting Started] - Improve hello world example
107+
Fix: [Advanced] - Correct formula syntax in budget tracker
108+
```
109+
110+
### All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md)
111+
112+
---
113+
114+
## 🤝 Community
115+
116+
Join our discussions on [GitHub Discussions](https://github.com/OmniScriptOSF/omniscript-core/discussions).
117+
118+
---
119+
120+
## 📄 License
121+
122+
By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).
123+
124+
All examples are provided as templates and may be freely used, modified, and distributed.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 OmniScriptOSF
3+
Copyright (c) 2025 Alphin Tom
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)