Skip to content

Commit ddf3707

Browse files
VarnasrVarnasr
committed
Update README with honest status, OpenStacks branding, and improved governance docs
1 parent 736a344 commit ddf3707

File tree

4 files changed

+188
-29
lines changed

4 files changed

+188
-29
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Code of Conduct
2+
3+
## Our Commitment
4+
5+
OpenStacks for Change is built for public interest work. We are committed to providing a welcoming, inclusive, and harassment-free experience for everyone — regardless of gender identity, sexual orientation, disability, ethnicity, religion, age, nationality, caste, class, or level of technical experience.
6+
7+
## Expected Behaviour
8+
9+
- **Be respectful and professional** in all interactions
10+
- **Be constructive** — offer feedback that helps improve the work
11+
- **Be inclusive** — use welcoming and gender-neutral language
12+
- **Be collaborative** — share knowledge generously and credit others' contributions
13+
- **Be honest** — about limitations, uncertainties, and the state of your work
14+
- **Respect privacy** — never share others' personal information or data
15+
16+
## Unacceptable Behaviour
17+
18+
- Harassment, intimidation, or discrimination of any kind
19+
- Sexualised language or imagery in any project space
20+
- Personal attacks, trolling, or deliberately inflammatory comments
21+
- Publishing others' private information without consent
22+
- Sustained disruption of discussions or project activities
23+
- Any conduct that would be considered inappropriate in a professional setting
24+
25+
## Scope
26+
27+
This code of conduct applies to all OpenStacks project spaces — including GitHub repositories, issues, pull requests, discussions, and any other communication channels associated with the project.
28+
29+
## Reporting
30+
31+
If you experience or witness unacceptable behaviour, please report it by emailing **varna.sr@gmail.com**. All reports will be handled confidentially.
32+
33+
## Enforcement
34+
35+
Project maintainers who do not follow or enforce this Code of Conduct may face temporary or permanent consequences as determined by the project leadership.
36+
37+
## Attribution
38+
39+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

‎CONTRIBUTING.md‎

Lines changed: 71 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,72 @@
1-
# Contributing
1+
# Contributing to OpenStacks
22

3-
Contributions are welcome! Please read the guidelines.
3+
Thank you for your interest in contributing to [OpenStacks for Change](https://openstacks.dev). This guide applies to all repositories in the ecosystem.
4+
5+
## Who Can Contribute
6+
7+
OpenStacks welcomes contributions from:
8+
9+
- **Development practitioners** — Share tools, templates, and workflows from your own work (anonymised)
10+
- **Researchers and evaluators** — Contribute analysis scripts, methodologies, and replication files
11+
- **Data analysts and engineers** — Improve code quality, add tests, fix bugs
12+
- **Writers and editors** — Improve documentation, add use case guides, fix errors
13+
- **Students** — Practice with real-world development data and contribute improvements
14+
15+
## How to Contribute
16+
17+
### Reporting Issues
18+
19+
- Use the repository's **Issues** tab to report bugs, suggest features, or ask questions
20+
- Check existing issues first to avoid duplicates
21+
- Use issue templates where available
22+
23+
### Submitting Changes
24+
25+
1. **Fork** the repository
26+
2. **Create a branch** for your change (`git checkout -b feature/your-feature-name`)
27+
3. **Make your changes** with clear, descriptive commit messages
28+
4. **Test your changes** — ensure scripts run and notebooks execute without errors
29+
5. **Submit a pull request** with a clear description of what you changed and why
30+
31+
### What Makes a Good Contribution
32+
33+
- **Self-contained** — Scripts should work independently with sample data
34+
- **Documented** — Include comments, a header description, and usage instructions
35+
- **Anonymised** — Never include real participant data, names, or identifying information
36+
- **Reproducible** — Include sample data or clear instructions for obtaining test data
37+
- **Tested** — Verify that your code runs without errors
38+
39+
## Contribution Ideas by Stack
40+
41+
| Stack | Good Contributions |
42+
|-------|-------------------|
43+
| **InsightStack** | MEL calculators, Stata/SPSS scripts, research templates |
44+
| **FieldStack** | R notebooks, survey tools, evaluation frameworks |
45+
| **EquityStack** | Python scripts, Jupyter notebooks, data workflows |
46+
| **SignalStack** | Research tool recommendations, method spotlights |
47+
| **RootStack** | Database schemas, seed data, SQL queries |
48+
| **BridgeStack** | FastAPI endpoints, data models, API tests |
49+
| **ViewStack** | Frontend components, chart templates, dashboard designs |
50+
| **PolicyStack** | Policy data, budget analysis scripts, government data scrapers |
51+
52+
## Code Style
53+
54+
- **Python:** Follow PEP 8. Use descriptive variable names.
55+
- **R:** Follow the tidyverse style guide. Use snake_case.
56+
- **Stata:** Use clear variable labels and value labels.
57+
- **Markdown:** Use ATX-style headers (`#`). Keep lines under 120 characters.
58+
59+
## Data Standards
60+
61+
- Use **CSV** for tabular data (UTF-8 encoding)
62+
- Include a **data dictionary** or codebook for any new datasets
63+
- **Never commit** real participant data, credentials, or API keys
64+
- Use **sample_data/** directories for test datasets
65+
66+
## Questions?
67+
68+
Open an issue in the relevant repository or email varna.sr@gmail.com.
69+
70+
## Code of Conduct
71+
72+
All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).

‎LICENSE‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
11
MIT License
22

3-
Copyright (c) 2025
3+
Copyright (c) 2025 Varna Sri Raman
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 59 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,72 @@
1+
# ViewStack
12

2-
<p align="center">
3-
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License"></a>
4-
<a href="CHANGELOG.md"><img src="https://img.shields.io/badge/changelog-updating-blue.svg" alt="Changelog"></a>
5-
<a href="https://buymeacoffee.com/varnasra"><img src="https://img.shields.io/badge/Support-BuyMeACoffee-yellow.svg" alt="Support Me"></a>
6-
</p>
7-
3+
**Frontend UI for OpenStacks data visualisation.**
84

9-
# ViewStack
5+
[![Part of OpenStacks](https://img.shields.io/badge/Part%20of-OpenStacks-blue)](https://openstacks.dev)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
7+
[![Status: Early Stage](https://img.shields.io/badge/Status-Early%20Stage-orange)]()
108

11-
> Frontend UI for visualizing and interacting with OpenStacks data.
9+
> The presentation layer for OpenStacks — interactive dashboards and data exploration.
1210
1311
---
1412

15-
![ViewStack Banner Placeholder](https://via.placeholder.com/1200x300.png?text=ViewStack+-+OpenStacks+Frontend+Layer)
13+
## Status
1614

17-
---
15+
**This repository is in early development.** The architecture and goals are documented below, but the frontend application has not yet been implemented. Contributions are welcome to help build this out.
1816

19-
# 📚 Table of Contents
20-
- [About](#about)
21-
- [Architecture](#architecture)
22-
- [Folder Structure](#folder-structure)
23-
- [Installation & Usage](#installation--usage)
24-
- [Roadmap](#roadmap)
25-
- [Contributing](#contributing)
26-
- [License](#license)
27-
- [Support Me](#support-me)
28-
- [Citation](#citation)
29-
- [Contact](#contact)
30-
- [Changelog](#changelog)
17+
## Vision
3118

32-
---
19+
ViewStack will provide the user-facing layer for exploring OpenStacks data:
20+
21+
- **Interactive dashboards** for development sector indicators
22+
- **Data exploration tools** with filtering and drill-down
23+
- **Chart and map visualisations** for spatial and temporal data
24+
- **Responsive design** for field use on mobile devices
25+
26+
### Planned Architecture
27+
28+
```
29+
RootStack (Database) → BridgeStack (API) → ViewStack (Frontend)
30+
```
31+
32+
ViewStack consumes the [BridgeStack](https://github.com/Varnasr/BridgeStack) REST API to display data stored in [RootStack](https://github.com/Varnasr/RootStack).
33+
34+
### Planned Structure
35+
36+
```
37+
ViewStack/
38+
├── src/
39+
│ ├── components/ # UI components
40+
│ ├── pages/ # Page-level views
41+
│ ├── charts/ # Visualisation components
42+
│ └── utils/ # Helper functions
43+
├── public/ # Static assets
44+
├── package.json # Dependencies
45+
└── vite.config.js # Build configuration
46+
```
47+
48+
## How to Contribute
49+
50+
This is a great repo to contribute to if you have experience with:
51+
- React, Vue, Svelte, or similar frontend frameworks
52+
- D3.js, Chart.js, or Leaflet for data visualisation
53+
- Responsive design for mobile-first applications
54+
- Accessibility (WCAG) standards
55+
56+
See the [OpenStacks hub](https://github.com/Varnasr/OpenStacks-for-Change) for ecosystem-wide contribution guidelines.
57+
58+
## How It Connects
59+
60+
| Stack | Role | Link |
61+
|-------|------|------|
62+
| [RootStack](https://github.com/Varnasr/RootStack) | Database schemas & seed data | Source of truth |
63+
| [BridgeStack](https://github.com/Varnasr/BridgeStack) | API backend (FastAPI) | Provides data via REST |
64+
| **ViewStack** (this repo) | Frontend UI | You are here |
65+
66+
## License
3367

68+
MIT — free to use, modify, and share. See [LICENSE](LICENSE).
3469

3570
---
3671

37-
<p align="center">
38-
Made with ❤️ by <b>Varna Sri Raman</b> • <a href="https://buymeacoffee.com/varnasra">Support my work</a> • <a href="mailto:varna.sr@gmail.com">Contact</a>
39-
</p>
72+
**Created by [Varna Sri Raman](https://github.com/Varnasr)** — Development Economist & Social Researcher

0 commit comments

Comments
 (0)