Skip to content

Commit 3e031f8

Browse files
committed
Added a Roadmap and Contributing guidelines
1 parent e0e62c1 commit 3e031f8

File tree

2 files changed

+89
-0
lines changed

2 files changed

+89
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to testingconferences.org
2+
3+
First off, thank you for considering contributing! It’s people like you who keep this list accurate and useful for the testing community.
4+
5+
## How Can I Contribute?
6+
7+
### 1. Adding a New Conference
8+
The most common way to help is by adding a conference that isn't on the list yet or updating one that is.
9+
- Search the current list to make sure it isn't already there.
10+
- Open a Pull Request (PR) adding the conference to the relevant data file.
11+
- Ensure you follow our data schema (see the `README.md` for field requirements).
12+
13+
### 2. Reporting an Issue
14+
If you find a broken link, an incorrect date, or a bug on the site:
15+
- **Check the Footer:** Find the **Site Version** in the footer of the website.
16+
- **Open an Issue:** Include the version number and a description of the error.
17+
18+
### 3. Improving the Site (DX/Quality)
19+
We are currently working through our [ROADMAP.md](./ROADMAP.md) to improve site quality and developer experience. If you want to help with Lighthouse scores, build scripts, or automation, please check the roadmap for "Open" tasks.
20+
21+
---
22+
23+
## Pull Request Guidelines
24+
To help us review your changes quickly, please follow these steps:
25+
26+
1. **Fork the repo** and create your branch from `main`.
27+
2. **Test your changes** locally to ensure the build passes.
28+
3. **Reference Issues**: If your PR fixes a bug, include `Closes #123` in the description.
29+
4. **Style**: Please ensure your code/data follows the project's formatting (Prettier/ESLint).
30+
31+
## Code of Conduct
32+
By participating in this project, you agree to abide by our Code of Conduct [link to file or text]. We strive to maintain a welcoming and inclusive environment.
33+
34+
---
35+
**Need help?** If you have questions about how to contribute, feel free to open a "Question" issue and we'll help you get started!

ROADMAP.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Roadmap: testingconferences.org
2+
3+
## Project Vision
4+
Continue to use TCorg to experiment and learn. I want to track quality metrics automatically. Yes these are indirect quality metrics, but I'd like to see what I can track on the build side and how it works. Then improve upon them later.
5+
6+
---
7+
8+
## Phase 1: Versioning & Traceability (High Priority)
9+
*Goal: Establish a "Source of Truth" for site deployments.*
10+
11+
- [x] **Implement `VERSION` file**: Create a plaintext file in the root directory to track SemVer (e.g., `1.0.0`).
12+
- [ ] **Footer Integration**: Update the website footer to dynamically display the current string from the `VERSION` file.
13+
- [ ] **Automated Increments**: Create a workflow to increment the `VERSION` file on every deployment.
14+
- [ ] **Deployment Tagging**: Ensure every production deploy is tagged in Git to match the internal version.
15+
16+
## Phase 2: Quality Ledger & Metrics
17+
*Goal: Associate every site version with a specific quality snapshot.*
18+
19+
- [ ] **Lighthouse Tracking**: Automate Lighthouse audits during CI and record Performance, Accessibility, and SEO scores per version.
20+
- [ ] **Link Integrity**: Implement a broken link checker (e.g., `linkinator`) to log broken link counts against the current version.
21+
- [ ] **Build Analytics**: Track and log build times to monitor the impact of site growth on CI/CD performance.
22+
- [ ] **Bug Attribution**: Update Issue Templates to include a "Site Version" field to track bug counts relative to specific releases.
23+
24+
## Phase 3: Developer Experience (DX) & AI Workflows
25+
*Goal: Streamline contributions using automation and AI context.*
26+
27+
- [ ] **Automatic Linting**: Set up Prettier and ESLint with pre-commit hooks (Husky) to ensure code consistency.
28+
- [ ] **AI Contextualization**: Create a `.github/copilot-instructions.md` to help GitHub Copilot understand the conference data schema and project goals.
29+
- [ ] **Prompt Imports**: Build a library of standardized prompts to assist contributors in formatting and validating new conference submissions.
30+
31+
## Phase 4: Public Quality Dashboard
32+
*Goal: Surface project health and transparency to the community.*
33+
34+
- [ ] **Metrics Dashboard**: Build a public-facing page (e.g., `/stats` or `/quality`) to visualize project health.
35+
- [ ] **Trend Visualization**: Display historical graphs of Lighthouse scores, bug counts, and conference growth over different versions.
36+
- [ ] **Live Status Badges**: Integrate dynamic README badges for current version, build status, and site health.
37+
38+
## Misc:
39+
*Goal: Other important features
40+
41+
- [ ] **Calendar Download**: Make it possible to just download the current TC.org data as a ICO and import it into your calendar
42+
- [ ] **Reference License in Footer**: Should we reference our MIT-LICENSE file in super footer?
43+
44+
---
45+
46+
## Version History & Quality Log
47+
*This table tracks the evolution of the site's quality over time.*
48+
49+
| Version | Release Date | Lighthouse (Perf) | Broken Links | Build Time | Bugs Found |
50+
| :--- | :--- | :--- | :--- | :--- | :--- |
51+
| v1.0.0 | 2025-XX-XX | TBD | TBD | TBD | TBD |
52+
53+
---
54+
*Last Updated: December 2025*

0 commit comments

Comments
 (0)