Skip to content

Commit a640913

Browse files
VarnasrVarnasr
committed
Update README with OpenStacks branding, cross-links, and improved governance docs
1 parent 8e874f1 commit a640913

4 files changed

Lines changed: 200 additions & 171 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
11
# Code of Conduct
22

3-
Please be respectful and professional.
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: 57 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,72 @@
1+
# Contributing to OpenStacks
12

2-
# CONTRIBUTING to FieldStack
3+
Thank you for your interest in contributing to [OpenStacks for Change](https://openstacks.dev). This guide applies to all repositories in the ecosystem.
34

4-
Thank you for your interest in contributing! This project is open to improvements from researchers, MEL professionals, and developers.
5+
## Who Can Contribute
56

6-
---
7+
OpenStacks welcomes contributions from:
78

8-
## 📦 Setup Instructions
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
914

10-
1. Clone the repo:
11-
```
12-
git clone https://github.com/Varnasr/FieldStack.git
13-
```
15+
## How to Contribute
1416

15-
2. Open the project in RStudio
17+
### Reporting Issues
1618

17-
3. Install required packages:
18-
```R
19-
install.packages(c("tidyverse", "sf", "testthat", "flexdashboard", "readxl"))
20-
```
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
2122

22-
---
23+
### Submitting Changes
2324

24-
## 🧪 Testing
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
2530

26-
Test scripts live in `tests/`. Run all tests with:
27-
```R
28-
library(testthat)
29-
test_dir("tests")
30-
```
31+
### What Makes a Good Contribution
3132

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
3338

34-
## 📄 Contribution Guidelines
39+
## Contribution Ideas by Stack
3540

36-
- Fork and create a branch for your edits
37-
- Add clear comments and minimal examples
38-
- Document new functions in README if relevant
39-
- Submit a pull request with a brief description
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 |
4051

41-
---
52+
## Code Style
4253

43-
We especially welcome:
44-
- Localised notebooks for India/South Asia context
45-
- Additional visualisation or dashboard tools
46-
- Translations, data ethics guidance, or mix-methods integrations
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 & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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.

0 commit comments

Comments
 (0)