Contributing to SustainableTogether¶
Thank you for wanting to contribute! This project is open to everyone — you do not need to be a systems engineer or sustainability expert to help.
Ways to Contribute¶
| Type | Description |
|---|---|
| Documentation | Improve guides, fix typos, add clarity |
| Presentations | Share slides or materials on sustainability and MBSE |
| System Model | Extend or refine the SolarX/SustainaSun MBSE model |
| Code | Python scripts, SysML models, web tools |
| Ideas | Propose a new direction or feature via an issue |
| Feedback | Review existing content and suggest improvements |
How to Contribute¶
1. Fork and clone the repository¶
git clone https://github.com/YOUR-USERNAME/SustainableTogether.git
cd SustainableTogether
2. Create a branch¶
git checkout -b your-branch-name
Use a descriptive name, e.g. add-glossary, fix-system-model-docs, feature-python-simulation.
3. Make your changes¶
Keep changes focused — one topic per pull request makes review easier.
4. Commit with a clear message¶
git commit -m "Add: brief description of what you did"
Common prefixes: Add:, Fix:, Update:, Remove:
5. Push and open a Pull Request¶
git push origin your-branch-name
Then go to GitHub and open a Pull Request against the main branch. Use the PR template provided.
Opening Issues¶
Use the provided templates when opening issues:
- Bug Report — something is incorrect or broken
- Feature Request — propose a new idea or improvement
- Content Contribution — share a resource, presentation, or document
Working on the Documentation Site Locally¶
The documentation site uses MkDocs Material. To run it locally:
# Install dependencies
pip install -r requirements.txt
# Serve locally
mkdocs serve
Then open http://127.0.0.1:8000 in your browser.
Code of Conduct¶
By participating, you agree to our Code of Conduct.
Questions?¶
Open a Discussion or email sustainability@incose.net.