scriptoriumadmin/veritas-kanban
1
0
Fork 0
mirror of https://github.com/BradGroux/veritas-kanban.git synced 2026-08-28 02:44:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: add LICENSE, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md

Browse source
This commit is contained in:
Brad Groux 2026-01-29 01:35:51 -06:00
parent 14e69b9204
commit f0616589e6
4 changed files with 311 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

83
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,83 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at conduct@digitalmeld.io. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

152
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,152 @@
# Contributing to Veritas Kanban
Thanks for your interest in contributing! This guide will help you get started.
## Prerequisites
- **Node.js** 20 or later
- **pnpm** (package manager)
## Development Setup
1. **Fork the repository** on GitHub
2. **Clone your fork:**
```bash
git clone https://github.com/<your-username>/veritas-kanban.git
cd veritas-kanban
```
3. **Install dependencies:**
```bash
pnpm install
```
4. **Set up environment variables:**
```bash
cp .env.example .env
```
Edit `.env` with your local configuration.
5. **Start the development server:**
```bash
pnpm dev
```
## Project Structure
Veritas Kanban is a monorepo:
```
veritas-kanban/
├── server/ # Backend API (Express + TypeScript)
├── web/ # Frontend UI (React + Vite + TypeScript)
├── shared/ # Shared types, utilities, constants
├── scripts/ # Build and utility scripts
└── ...
```
## Development Workflow
1. Create a feature branch from `main`:
```bash
git checkout -b feat/my-feature
```
2. Make your changes — write code, add tests, update docs.
3. Run linting and tests before committing:
```bash
pnpm lint
pnpm test
```
4. Commit using [conventional commits](#commit-conventions).
5. Push to your fork and open a pull request.
## Commit Conventions
We follow [Conventional Commits](https://www.conventionalcommits.org/).
### Format
```
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
```
### Types
| Type | Description |
| ---------- | --------------------------------------------------- |
| `feat` | A new feature |
| `fix` | A bug fix |
| `docs` | Documentation changes |
| `style` | Code style (formatting, semicolons, etc.) |
| `refactor` | Code change that doesn't fix a bug or add a feature |
| `perf` | Performance improvement |
| `test` | Adding or updating tests |
| `build` | Build system or dependency changes |
| `ci` | CI/CD configuration changes |
| `chore` | Other changes (no src or test modification) |
### Examples
```
feat(board): add drag-and-drop column reordering
fix(api): handle empty task list in export endpoint
docs: update README with deployment instructions
```
## Pull Request Process
1. **Fork** the repo and create your branch from `main`.
2. **Branch naming:** Use descriptive names like `feat/task-filters`, `fix/login-redirect`, `docs/api-reference`.
3. **Open a PR** against `main`.
4. **Fill out the PR template** — describe changes, link related issues, include screenshots for UI changes.
5. **Ensure CI passes** — all checks must be green.
6. **Request review** — a maintainer will review and may request changes.
7. **Address feedback** — push additional commits as needed.
8. **Merge** — once approved, a maintainer will merge.
## Code Style
- **Language:** TypeScript (strict mode)
- **Linting:** ESLint — `pnpm lint`
- **Formatting:** Prettier — `pnpm format`
- **Editor:** VS Code recommended with ESLint + Prettier extensions
Follow the existing conventions in `.eslintrc.*`, `.prettierrc`, and `tsconfig.json`.
## Testing
- **Run all tests:**
```bash
pnpm test
```
- **End-to-end tests** use [Playwright](https://playwright.dev/):
```bash
pnpm test:e2e
```
- Write tests for new features and bug fixes.
- Ensure existing tests pass before submitting.
## Questions?
Open a [GitHub Discussion](https://github.com/dm-bradgroux/veritas-kanban/discussions) or reach out to the maintainers.
Thanks for contributing! 🎉

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 Digital Meld
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.

55
SECURITY.md Normal file
View file

@ -0,0 +1,55 @@
# Security Policy
## Reporting a Vulnerability
We take security seriously. If you discover a vulnerability, please report it responsibly.
**Do NOT open a public GitHub issue for security vulnerabilities.**
Instead, email us at:
📧 **[security@digitalmeld.io](mailto:security@digitalmeld.io)**
### What to Include
- A description of the vulnerability
- Steps to reproduce the issue
- The potential impact
- Any suggested fixes (if applicable)
### Response Timeline
| Step | Timeline |
| ------------------ | ------------------------------------------------ |
| **Acknowledgment** | Within **48 hours** of your report |
| **Fix timeline** | Communicated within **7 days** of acknowledgment |
| **Resolution** | As quickly as possible, depending on severity |
We will work with you to understand the issue and coordinate disclosure.
## Scope
This policy applies to:
- The **Veritas Kanban** application (all components)
- Direct dependencies used by the application
- The official deployment infrastructure
### Out of Scope
- Third-party services or applications that integrate with Veritas Kanban
- Vulnerabilities in dependencies that have already been publicly disclosed with upstream fixes available
- Social engineering attacks
## Supported Versions
| Version | Supported |
| ----------------- | -------------- |
| Latest release | ✅ |
| Previous releases | ⚠️ Best effort |
## Recognition
We value the security research community. With your permission, we will acknowledge your contribution in our release notes when a vulnerability is fixed.
Thank you for helping keep Veritas Kanban and its users safe.