Skip to content

Commit b962e76

Browse files
committed
Add open source infrastructure and documentation site
1 parent 3d862e2 commit b962e76

23 files changed

+978
-6
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug Report
3+
about: Something is incorrect or broken in the content, models, or code
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## What is wrong?
10+
11+
_A clear and concise description of the problem._
12+
13+
## Where does it occur?
14+
15+
_File, section, page, or component where the issue is found._
16+
17+
## Expected behavior
18+
19+
_What should it say or do instead?_
20+
21+
## Steps to reproduce (if applicable)
22+
23+
1. Go to '...'
24+
2. See error
25+
26+
## Additional context
27+
28+
_Screenshots, links, or any other relevant information._

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a Question / Start a Discussion
4+
url: https://github.com/TheNightFox-1/SustainableTogether/discussions
5+
about: Use GitHub Discussions for questions, ideas, and open-ended conversations.
6+
- name: Contact the Team
7+
url: mailto:sustainability@incose.net
8+
about: Reach out directly to the SustainableTogether team.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Content Contribution
3+
about: Share a presentation, document, resource, or piece of knowledge
4+
title: "[CONTENT] "
5+
labels: content
6+
assignees: ''
7+
---
8+
9+
## What are you contributing?
10+
11+
_Brief description of the content (presentation, guide, model, paper, etc.)._
12+
13+
## Topic / Category
14+
15+
_e.g. Sustainability, MBSE, Solar Energy, Systems Thinking, Business Design_
16+
17+
## Source / Author
18+
19+
_Who created it? Is it openly licensed?_
20+
21+
## How to access it
22+
23+
_Link, file attachment, or description of how to include it._
24+
25+
## Why is this relevant to SustainableTogether?
26+
27+
_How does it support the project's mission?_
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request / Improvement
3+
about: Propose a new idea, improvement, or direction for the project
4+
title: "[IDEA] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## What do you want to improve or add?
10+
11+
_A clear description of your idea._
12+
13+
## Why is this valuable?
14+
15+
_How does this help the community or advance the project's mission?_
16+
17+
## Proposed approach (optional)
18+
19+
_How might this be implemented or structured?_
20+
21+
## Additional context
22+
23+
_Links, references, examples, or related work._

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Summary
2+
3+
_What does this PR change and why?_
4+
5+
## Type of change
6+
7+
- [ ] Bug fix (corrects something wrong)
8+
- [ ] New content (documentation, presentation, resource)
9+
- [ ] Model / system design update
10+
- [ ] Code (new feature or improvement)
11+
- [ ] Other: ___
12+
13+
## Related issue(s)
14+
15+
_Closes #_
16+
17+
## Checklist
18+
19+
- [ ] My changes are focused on one topic
20+
- [ ] I have checked for typos and formatting issues
21+
- [ ] I have added a description of what changed and why
22+
- [ ] Any new files are placed in the correct folder
23+
- [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md)

.github/workflows/deploy-docs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
deploy:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Set up Python
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: '3.x'
25+
26+
- name: Install dependencies
27+
run: pip install -r requirements.txt
28+
29+
- name: Deploy to GitHub Pages
30+
run: mkdocs gh-deploy --force

.gitignore

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# OS artifacts
2+
.DS_Store
3+
.DS_Store?
4+
._*
5+
.Spotlight-V100
6+
.Trashes
7+
ehthumbs.db
8+
Thumbs.db
9+
desktop.ini
10+
11+
# Editor / IDE
12+
.vscode/
13+
.idea/
14+
*.swp
15+
*.swo
16+
*~
17+
18+
# Python
19+
__pycache__/
20+
*.py[cod]
21+
*.pyo
22+
*.pyd
23+
.Python
24+
env/
25+
venv/
26+
.venv/
27+
ENV/
28+
*.egg-info/
29+
dist/
30+
build/
31+
.eggs/
32+
*.egg
33+
.pytest_cache/
34+
.coverage
35+
htmlcov/
36+
.mypy_cache/
37+
38+
# Node / Web
39+
node_modules/
40+
npm-debug.log*
41+
yarn-debug.log*
42+
yarn-error.log*
43+
.pnpm-debug.log*
44+
dist/
45+
.next/
46+
.nuxt/
47+
.output/
48+
.env
49+
.env.local
50+
.env.*.local
51+
52+
# MkDocs build output
53+
site/
54+
55+
# SysML / MBSE model artifacts (common tool outputs)
56+
*.bak
57+
*.tmp
58+
*.lock
59+
.metadata/
60+
61+
# Jupyter
62+
.ipynb_checkpoints/
63+
64+
# General
65+
*.log
66+
*.zip
67+
*.tar.gz

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
All notable changes to SustainableTogether will be documented here.
4+
5+
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6+
7+
---
8+
9+
## [Unreleased]
10+
11+
### Added
12+
- Open source infrastructure: LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY
13+
- GitHub issue and PR templates
14+
- GitHub Actions workflow for automated documentation deployment
15+
- MkDocs documentation site (GitHub Pages)
16+
- Comprehensive README
17+
18+
---
19+
20+
<!-- Add new releases above this line in the format:
21+
22+
## [1.0.0] - YYYY-MM-DD
23+
### Added
24+
### Changed
25+
### Fixed
26+
### Removed
27+
28+
-->

CODE_OF_CONDUCT.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders of SustainableTogether pledge to make participation in our community a respectful, inclusive, and harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act in ways that contribute to an open, welcoming, diverse, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive feedback
16+
- Focusing on what is best for the community and the project
17+
- Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior:
20+
21+
- The use of sexualized language or imagery
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information without explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Project maintainers are responsible for clarifying and enforcing these standards. They will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all project spaces, including the GitHub repository, issue tracker, pull requests, and any community channels associated with this project.
34+
35+
## Enforcement
36+
37+
Instances of unacceptable behavior may be reported to the project team at **sustainability@incose.net**. All complaints will be reviewed and investigated promptly and fairly. The project team is obligated to maintain confidentiality with regard to the reporter.
38+
39+
## Attribution
40+
41+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to SustainableTogether
2+
3+
Thank you for your interest in contributing! SustainableTogether is an open community project — every contribution counts, whether you're fixing a typo, sharing knowledge, improving the system model, or writing code.
4+
5+
## Who Can Contribute?
6+
7+
Everyone. You don't need to be a systems engineer or sustainability expert. If you care about making sustainable practices more accessible and understandable, you belong here.
8+
9+
## Ways to Contribute
10+
11+
| Type | Description |
12+
|------|-------------|
13+
| **Documentation** | Improve guides, fix typos, translate content |
14+
| **Presentations** | Share slides or materials related to sustainability and MBSE |
15+
| **System Model** | Extend or refine the SolarX/SustainaSun system model |
16+
| **Code** | Contribute Python scripts, SysML models, or web tools |
17+
| **Ideas** | Open an issue to propose a new direction or feature |
18+
| **Feedback** | Review existing content and suggest improvements |
19+
20+
## Getting Started
21+
22+
1. **Fork** this repository
23+
2. **Clone** your fork locally
24+
3. Create a **new branch** for your contribution:
25+
```bash
26+
git checkout -b your-branch-name
27+
```
28+
4. Make your changes
29+
5. **Commit** with a clear message:
30+
```bash
31+
git commit -m "Add: brief description of what you did"
32+
```
33+
6. **Push** to your fork and open a **Pull Request**
34+
35+
## Contribution Guidelines
36+
37+
- Keep changes focused — one topic per pull request
38+
- Write clear commit messages (what and why, not just what)
39+
- If adding documentation, use plain English that anyone can understand
40+
- If adding code, include a brief comment explaining what it does
41+
- Reference related issues in your PR description (e.g. `Closes #12`)
42+
43+
## Opening Issues
44+
45+
Use the issue templates provided:
46+
- **Bug Report** — something is wrong or broken
47+
- **Feature Request** — propose a new idea or improvement
48+
- **Content Contribution** — share a resource, presentation, or document
49+
50+
## Code of Conduct
51+
52+
By participating, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
53+
54+
## Questions?
55+
56+
Open a [GitHub Discussion](https://github.com/TheNightFox-1/SustainableTogether/discussions) or reach out at **sustainability@incose.net**.

0 commit comments

Comments
 (0)