Skip to content

Commit ad30461

Browse files
VarnasrVarnasr
committed
Update README with OpenStacks branding, cross-links, and improved governance docs
1 parent 5bc341d commit ad30461

4 files changed

Lines changed: 171 additions & 50 deletions

File tree

‎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: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing to OpenStacks
2+
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: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
MIT License
1+
MIT License
2+
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: 39 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,64 @@
1-
<p align="center">
2-
<a href="https://varnasr.github.io/SignalStack/" target="_blank">
3-
<img src="https://img.shields.io/badge/View%20Live%20Site-SignalStack-brightgreen?style=for-the-badge&logo=github" alt="View SignalStack Live Site">
4-
</a>
5-
</p>
1+
# SignalStack
62

7-
# 🚀 SignalStack
3+
**Research Rundown newsletter archive and curated development resources.**
84

9-
**SignalStack** is the companion repository for the *Research Rundown* newsletter —
10-
bringing you curated insights, research resources, and updates from the world of development policy, social research, and climate resilience.
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)
117

12-
Stay updated with live issues, featured tools, and companion notes.
8+
> Curated insights, research resources, and updates from the world of development policy, social research, and climate resilience.
139
1410
---
1511

16-
## 📖 Table of Contents
12+
## What This Is
1713

18-
- [About SignalStack](#about-signalstack)
19-
- [Latest Issues](#latest-issues)
20-
- [Featured Tools](#featured-tools)
21-
- [Resources](#resources)
22-
- [What's New](#whats-new)
23-
- [Stay Connected](#stay-connected)
14+
SignalStack is the companion repository for the **Research Rundown** newsletter. It hosts archived newsletter issues, featured research tools, method spotlights, and curated resources for development practitioners.
2415

25-
---
26-
27-
## 📚 About SignalStack
16+
This is the **knowledge curation layer** of [OpenStacks for Change](https://openstacks.dev) — an open ecosystem of tools for public interest research and evaluation.
2817

29-
SignalStack hosts:
18+
## What's Inside
3019

31-
- Links to each live edition of *Research Rundown*.
32-
- Summaries and companion notes.
33-
- Featured research tools and resources for practitioners.
20+
```
21+
SignalStack/
22+
├── issues/ # Newsletter issue archives with summaries
23+
├── featured/ # Featured research tools and methods
24+
├── extras/ # Extended notes and companion materials
25+
├── assets/banner/ # Visual assets
26+
├── index.md # Landing page content
27+
└── package.json # Automation config
28+
```
3429

35-
---
30+
## Newsletter Issues
3631

37-
## 🗓️ Latest Issues
32+
| Issue | Date | Topics |
33+
|-------|------|--------|
34+
| Issue 2 | April 2025 | Gender-responsive climate resilience, health equity |
35+
| Issue 1 | June 2024 | Food security, ocean gender equity |
3836

39-
- [Issue 2 (April 2025)](issues/april-2025/)
40-
- [Issue 1 (June 2024)](issues/june-2024/)
37+
## How It Connects
4138

42-
---
39+
SignalStack is one of several stacks in the [OpenStacks](https://openstacks.dev) ecosystem:
4340

44-
## 🛠️ Featured Tools
41+
| Stack | Focus | Link |
42+
|-------|-------|------|
43+
| [InsightStack](https://github.com/Varnasr/InsightStack) | MEL tools, calculators, documentation | Knowledge systems |
44+
| [FieldStack](https://github.com/Varnasr/FieldStack) | R notebooks for fieldwork & evaluation | Applied data work |
45+
| [EquityStack](https://github.com/Varnasr/EquityStack) | Python workflows for development data | Data pipelines |
46+
| **SignalStack** (this repo) | Research Rundown newsletter archive | You are here |
4547

46-
*(Coming soon — selected resources from issues.)*
48+
**SignalStack curates and highlights** tools and methods from the other stacks. If you find a tool here that interests you, follow the link to the relevant stack for the actual code.
4749

48-
---
50+
## Subscribe
4951

50-
## 📂 Resources
52+
Follow the [Research Rundown newsletter](https://researchrundown.substack.com) for regular updates on development research, open data, and practitioner tools.
5153

52-
*(Coming soon — categorized guides, policy toolkits, research reports.)*
54+
## Contributing
5355

54-
---
56+
Have a research tool, method, or resource to feature? See [CONTRIBUTING.md](CONTRIBUTING.md) or open an issue.
5557

56-
## ✨ What's New
58+
## License
5759

58-
- **April 2025**: Added Issue 2 featuring gender-responsive climate resilience, health equity toolkits, and research governance insights.
59-
- **June 2024**: Repository launched with Issue 1, covering food security, climate science, gender equity in oceans, and open science tools.
60+
MIT — free to use, modify, and share. See [LICENSE](LICENSE).
6061

6162
---
6263

63-
## 📬 Stay Connected
64-
65-
- 📖 [Subscribe to Research Rundown](https://open.substack.com/pub/varna)
66-
- 🌐 [Explore OpenStacks.dev](https://openstacks.dev/)
67-
- ✉️ Contact: varna.sr@gmail.com
68-
69-
---
70-
71-
## 📜 Changelog
72-
73-
This project maintains an up-to-date [CHANGELOG.md](./CHANGELOG.md) that is automatically updated on every push to the `main` branch using GitHub Actions.
74-
All changes are documented automatically for better tracking and visibility.
64+
**Created by [Varna Sri Raman](https://github.com/Varnasr)** — Development Economist & Social Researcher

0 commit comments

Comments
 (0)