Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @Woman4Coding
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Short description of the change -->
## Summary

What changed and why (one or two sentences).

Fixes # (issues)

## Type of change

Keep relevant options.

- [ ] Bug fix (non-breaking change to fix an issue)
- [ ] New feature (non-breaking change to add functionality)
- [ ] Breaking change (fix or feature that causes existing functionality to not work as expected)
- [ ] Documentation update

## How I used Copilot for this PR
- Prompts used (short)
- Files generated/assisted by Copilot
- What I reviewed/edited manually

## Testing
- Steps to reproduce
- Unit/integration tests added

## Checklist
- [ ] I ran tests locally
- [ ] I updated docs if needed
- [ ] PR description explains Copilot usage and manual review
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Woman4Coding

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
35 changes: 35 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[] Add CONTRIBUTING.md
# Contributing

Welcome — thank you for contributing!

How we use Copilot in this repo
- Use Copilot for suggestions, code generation, tests, and docs drafts.
- When accepting Copilot suggestions, record the prompt in PRs: this helps trace the origin and review changes.
- Keep human reviewers in the loop for all security-related code.

Developer setup
1. Install your editor (VS Code, JetBrains) and the GitHub Copilot extension.
2. Enable Copilot Chat for interactive assistance (if available in your plan).
3. Use the provided `devcontainer` for reproducible environments.

Prompt hygiene
- Keep prompts concise and reproducible.
- Save prompt templates in `docs/prompts/` and record prompt variations in PRs.

Contribution steps
- Create an issue or pick up an existing one.
- Open a branch named `feat/<short-desc>` or `fix/<short-desc>`.
- Create a PR referencing the issue.
- In PR body, document which Copilot prompts were used.


[] Configure public repo
controlled setup for a public repository that will be used to demonstrate Copilot end-to-end.

First-public-repo checklist (before making the repo public):
- [ ] Confirm content has no secrets (run a quick grep for API keys)
- [ ] Choose an appropriate license (MIT provided)
- [ ] Set repository description and topics
- [ ] Create CODE_OF_CONDUCT.md and CONTRIBUTING.md (contributing file present)
- [ ] Add an initial release note and set main branch protections after the first commit
26 changes: 26 additions & 0 deletions docs/copilot-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# GitHub Copilot: feature mapping by plan

This document maps commonly available Copilot features to product plans. Exact availability may change; check GitHub account billing and Copilot settings in your GitHub account for the definitive list.

- Copilot Free
- Basic inline code completions in supported editors
- Limited access to Copilot suggestions; no organization-level controls
- Useful for local productivity, small code snippets, and exploring prompt patterns

- Copilot (Individual / Paid)
- Line and multi-line completions with higher usage limits
- Copilot Chat in supported IDEs
- PR and code-assist features in GitHub web and PR workflows

- Copilot for Business
- Centralized license management for teams
- Admin controls, usage visibility, and policy enforcement
- Better integration for Codespaces and org-managed environments

- Copilot for Enterprise
- Enterprise-grade controls: SSO, data residency, telemetry and advanced policy
- Options for private model access or enterprise models (varies by customer)
- Dedicated support and compliance-focused features

Notes
- Plans change over time; consult GitHub billing and product pages for up-to-date details.
32 changes: 32 additions & 0 deletions docs/copilot-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Guide: Using Copilot across the SDLC (step-by-step)

Phase-by-phase usage and example prompts

Phase 0 — Discovery & requirements
- Goal: turn an idea into scoped user stories and acceptance criteria
- Example prompt:
"You are a product analyst. Given this idea: 'task-runner web app with OAuth login, persistent tasks, and scheduling', write 8 user stories ordered by priority with acceptance criteria."

Phase 1 — Scaffold & templates
- Create issue and PR templates and a CI workflow
- Example prompt to scaffold files:
"Create a minimal README, CONTRIBUTING, and GitHub workflow for a Node.js project that runs tests with npm test."

Phase 2 — Implementation & tests
- Use Copilot to suggest code, but always review and run tests
- Example prompt to generate tests:
"Write Jest unit tests for a function formatDate(date) that returns 'YYYY-MM-DD' and returns null for falsy input."

Phase 3 — CI/CD & automation
- Use GitHub Actions to run lint/test on PRs and optionally build artifacts
- Use Dependabot to keep dependencies updated

Phase 4 — PR review & release
- In PR template record prompts used and manual checks performed
- Use Copilot to draft PR descriptions and release notes, then validate them manually

Phase 5 — Governance & production
- Protect main branch, require PR reviews, enable code scanning and secret scanning
- Define policy for accepting Copilot suggestions (we recommend documenting prompts in PRs)

Prompts library location: `docs/prompts/`
11 changes: 11 additions & 0 deletions docs/prompts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Prompt library (examples)

This folder stores prompt templates and examples that have been validated by the team.

Example: requirements -> user stories
"You are a product analyst. Given this short idea: 'chat-based todo app with due dates and reminders', create 6 user stories with acceptance criteria suitable for a single 2-week sprint."

Example: tests
"Write unit tests for function 'sum(a,b)' which returns the numeric sum and throws when inputs are not numbers. Use Jest."

Add validated prompts as you refine them.