Contributing

​

About VulnTrack

​

Code of Conduct

• Be respectful and inclusive
• Accept constructive criticism gracefully
• Focus on what is best for the community
• Show empathy towards other community members

​

Ways to Contribute

​

Getting Started

​

1. Fork and Clone

git clone https://github.com/YOUR_USERNAME/vulntrack.git
cd vulntrack

git remote add upstream https://github.com/ogdmerlin/vulntrack.git

​

2. Set Up Development Environment

npm install

cp .env.example .env

npx prisma generate
npx prisma db push
npx prisma db seed

npm run dev

​

3. Create a Branch

git checkout -b feature/your-feature-name

• feature/ - New features
• fix/ - Bug fixes
• docs/ - Documentation changes
• refactor/ - Code refactoring
• test/ - Test additions or modifications

​

Development Guidelines

​

Code Style

• Use TypeScript for type safety
• Follow ESLint rules (run npm run lint)
• Use functional components with hooks
• Keep components small and focused
• Write self-documenting code with clear names

​

Testing

• Test changes manually in the browser
• Verify database operations complete successfully
• Test with different user roles (Admin, Analyst, Viewer)
• Check responsive design on multiple screen sizes
• Verify dark mode compatibility

​

Database Changes

1. Update the Prisma schema (prisma/schema.prisma)
2. Create a migration:
   npx prisma migrate dev --name your_migration_name
   
3. Update seed data if necessary (prisma/seed.js)
4. Document the schema change in your PR

​

Security Considerations

• Never commit secrets or credentials
• Use parameterized queries (Prisma handles this)
• Validate and sanitize user input
• Implement proper authorization checks
• Follow OWASP secure coding practices
• Report security vulnerabilities privately (see Security Policy)

​

Contribution Workflow

​

1. Make Your Changes

• Write clean, well-documented code
• Follow existing code style and patterns
• Add comments for complex logic
• Update documentation if needed

​

2. Commit Your Changes

git add .
git commit -m "feat: add STRIDE threat category filtering"

type: short description

[optional longer description]

[optional footer]

• feat: - New feature
• fix: - Bug fix
• docs: - Documentation changes
• style: - Code style changes (formatting, no logic change)
• refactor: - Code refactoring
• test: - Adding or updating tests
• chore: - Maintenance tasks

​

3. Push to Your Fork

git push origin feature/your-feature-name

​

4. Open a Pull Request

Fixes #123
Relates to #456

​

5. Respond to Feedback

• Address all feedback promptly
• Make additional commits to your branch
• Push updates to the same PR
• Engage in constructive discussion

​

Documentation Contributions

​

Documentation Site

• Located in docs/ directory
• Written in MDX (Markdown with React components)
• Built with Mintlify

1. Edit MDX files in docs/
2. Preview changes locally (if Mintlify CLI installed)
3. Submit PR with documentation updates

​

VulnTrack Research Blog

• Write in MDX format
• Include code examples and diagrams
• Follow professional typography standards
• Focus on educational content

• Vulnerability analysis and case studies
• Security framework comparisons
• Threat modeling techniques
• Tool integration guides

​

Reporting Bugs

​

Before Reporting

• Check existing issues to avoid duplicates
• Verify the bug on the latest version
• Gather reproduction steps

​

Bug Report Template

## Description
Clear description of the bug.

## Steps to Reproduce
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

## Expected Behavior
What you expected to happen.

## Actual Behavior
What actually happened.

## Environment
- VulnTrack Version: [e.g., 0.1.0]
- Node.js Version: [e.g., 20.x]
- PostgreSQL Version: [e.g., 15.x]
- OS: [e.g., Ubuntu 22.04]
- Browser: [e.g., Chrome 120]

## Screenshots
If applicable, add screenshots.

## Additional Context
Any other relevant information.

​

Requesting Features

​

Feature Request Template

## Feature Description
Clear description of the proposed feature.

## Problem It Solves
What problem does this feature address?

## Proposed Solution
How would you implement this feature?

## Alternatives Considered
What other approaches did you consider?

## Additional Context
Mockups, examples, or related projects.

​

Community

​

GitHub Discussions

• General questions
• Feature ideas and brainstorming
• Show and tell (integrations, deployments)
• Community support

​

GitHub Issues

• Bug reports
• Confirmed feature requests
• Documentation issues
• Task tracking

​

License

MIT License

Copyright (c) 2025 OG DMERLIN

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.

• ✅ Commercial use allowed
• ✅ Modification allowed
• ✅ Distribution allowed
• ✅ Private use allowed
• ⚠️ No warranty provided
• 📄 License and copyright notice required

​

Recognition

• In the GitHub contributors list
• In release notes for significant contributions
• In the VulnTrack community