Skip to content
Merged
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
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug report
description: Report a bug or unexpected behavior in the project
title: "Bug Report"
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug. Please fill out the details below so we can investigate quickly.

- type: input
id: summary
attributes:
label: Short summary
description: One-line description of the issue
placeholder: e.g. Login form fails on empty email
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: List the exact steps that cause the issue
placeholder: |
1. Open the app
2. Go to login
3. Submit the form
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
placeholder: What should happen instead?
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behavior
placeholder: What happened instead?
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Browser, OS, Node version, app route, or other relevant details
placeholder: |
- OS:
- Browser:
- Node version:
- App route:
- Build or branch:
validations:
required: false

- type: textarea
id: logs
attributes:
label: Relevant logs or screenshots
description: Add console output, screenshots, or stack traces if available
placeholder: Paste logs or drag screenshots here
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Feature request
description: Suggest a new feature or enhancement for the project
title: "Feature Request"
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting an improvement. Please describe the idea and its value clearly.

- type: input
id: summary
attributes:
label: Feature summary
description: A brief title for the idea
placeholder: e.g. Add category filters to the library page
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem or need
description: What problem are you trying to solve?
placeholder: Describe the limitation or user need.
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Explain the feature or workflow you want to add
placeholder: Describe the behavior or UI changes you expect.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
placeholder: What other approaches or workarounds have you considered?
validations:
required: false

- type: textarea
id: context
attributes:
label: Additional context
description: Add screenshots, user stories, references, or implementation ideas
placeholder: Add any extra context here.
validations:
required: false
25 changes: 22 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,30 @@
# Pull Request

## 📌 Summary
## Summary

Explain what this PR does and why.
Describe the purpose of this pull request and the problem it solves.

## 🛠️ Changes Made
## Changes made

- [ ] Feature added
- [ ] Bug fixed
- [ ] Documentation updated
- [ ] Tests added or updated
- [ ] UI/UX changes
- [ ] Backend/API changes

## Why this change is needed

Explain the motivation, user impact, or issue being addressed.

## Testing

Describe how this was validated.

- [ ] Manual testing completed
- [ ] Automated tests run
- [ ] No relevant tests were available

## Notes

Add any migration steps, follow-up tasks, screenshots, or blockers.
52 changes: 52 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Code of Conduct

## Our Pledge

We are committed to building SignPakCommons as a respectful, inclusive, and collaborative project. We welcome contributors from all backgrounds, skill levels, and perspectives, and we expect all participation in this project to be constructive and professional.

## Our Standards

Examples of behavior that contributes to a positive environment include:

- being kind, respectful, and patient with others
- giving and receiving feedback constructively
- focusing on the project goals, user impact, and technical quality
- acknowledging the work and effort of other contributors
- helping others learn and grow in a supportive way

Examples of unacceptable behavior include:

- harassment, intimidation, or personal attacks
- discriminatory, insulting, or exclusionary language
- threatening or abusive communication
- repeatedly derailing discussions or blocking progress without cause
- sharing private information without consent
- behavior that undermines the safety or dignity of contributors or users

## Scope

This Code of Conduct applies to all project spaces, including:

- GitHub issues, pull requests, and discussions
- repository communication channels
- meetings, events, and project-related collaboration
- any public or private activity associated with SignPakCommons

## Enforcement Responsibilities

Project maintainers are responsible for clarifying and enforcing this Code of Conduct. They may take any action they consider appropriate, including:

- editing or removing harmful content
- asking for a change in behavior
- temporarily restricting participation
- removing access or banning contributors in serious or repeated cases

## Reporting

If you experience or witness unacceptable behavior, please report it privately to the project maintainers through the repository owner contact channels or the appropriate project communication route. Include as much context as possible, such as links, screenshots, dates, and the people involved.

Reports will be reviewed promptly and handled confidentially, with a focus on maintaining a safe and respectful community.

## Attribution

This Code of Conduct is adapted from the Contributor Covenant and tailored to the SignPakCommons community.
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing to SignPakCommons

Thank you for your interest in contributing to SignPakCommons. This project exists to support Pakistan Sign Language data collection and accessibility work, and we value thoughtful, respectful contributions.

## Ways to Contribute

You can help in several ways:

- report bugs or usability issues
- propose features or improvements
- improve documentation
- help with frontend or backend development
- improve testing or QA coverage
- contribute to data collection workflows and validation

## Before You Start

1. Read the project overview in [README.md](README.md).
2. Check the open issues and pull requests to avoid duplicating work.
3. Start with a small, focused change if you are new to the project.
4. Keep discussions respectful and grounded in the project mission and user impact.

## Development Setup

### Frontend

```bash
cd frontend
npm install
npm run dev
```

### Backend

```bash
cd backend
npm install
npm run dev
```

For local backend work, create the environment configuration required by the app before starting the server, using the sample environment file or setup notes in the backend documentation.

## Contribution Workflow

1. Fork the repository and create a branch for your work.
2. Make focused changes with clear commit messages.
3. Run the relevant checks for the area you modified.
4. Open a pull request with a clear description of the change and why it matters.
5. Be responsive to review feedback and update the PR as needed.

## Pull Request Guidelines

- Keep changes small and easy to review.
- Explain the problem being solved and the expected outcome.
- Include screenshots or examples when the change affects user-facing behavior.
- Update relevant documentation when the behavior or workflow changes.
- Ensure the code follows the project's existing patterns and conventions.

## Coding Standards

- Write readable, maintainable code.
- Prefer small, clear functions and simple logic.
- Follow the repo's existing style and naming conventions.
- Add or update tests when the change affects behavior.

## Community Expectations

Please read and follow the project's [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). We aim to make this a welcoming and productive environment for everyone.

## Questions

If you are unsure where to start, open an issue and ask. We are happy to help guide new contributors.
34 changes: 34 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Security Policy

## Supported Versions

This project is under active development. Security updates are prioritized for the current main branch and any actively maintained release line.

## Reporting a Vulnerability

Please do not report security vulnerabilities through public issues or pull requests.

If you believe you have found a security issue, report it privately to the maintainers through the repository owner contact channels or the project's private security reporting route. Please include:

- a clear description of the vulnerability
- affected components or endpoints
- steps to reproduce the issue
- potential impact
- any suggested fix or mitigation

## Response Expectations

We will make our best effort to:

- acknowledge valid reports promptly
- assess the severity and impact
- provide updates as the investigation progresses
- release a fix or mitigation as quickly as possible when needed

## Responsible Disclosure

We ask that reporters work with us to keep the issue private until a fix is available. Please do not disclose the vulnerability publicly before a coordinated resolution has been completed.

## Scope

This policy applies to security issues in the project codebase, configuration, deployment workflows, and project-maintained services related to SignPakCommons.
Loading
Loading