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
60 changes: 60 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Contributing to KDM-CLI

First off, thank you for considering contributing to KDM-CLI! It's people like you that make KDM-CLI such a great tool.

## Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to the project maintainers.

## How Can I Contribute?

### Reporting Bugs

Before creating bug reports, please check the [issue tracker](https://github.com/KDM-cli/kdm-cli/issues) to see if the problem has already been reported. If it hasn't, please open a new issue.

When reporting a bug, please include:
- Your operating system and version.
- The version of Node.js you are using.
- The version of KDM-CLI you are using.
- Detailed steps to reproduce the bug.
- Any relevant logs or error messages.

### Suggesting Enhancements

If you have an idea to improve KDM-CLI, please open an issue in the [issue tracker](https://github.com/KDM-cli/kdm-cli/issues) and label it as an enhancement (or feature request). Include as much detail as possible about your idea and why it would be beneficial.

### Pull Requests

1. Fork the repo and create your branch from `main`.
2. Ensure you have Node.js installed.
3. Run `npm install` to install dependencies.
4. If you've added code that should be tested, add tests.
5. Ensure the test suite passes by running `npm run test`.
6. Ensure your code builds successfully with `npm run build`.
7. Issue that pull request!

## Development Setup

To set up your development environment:

1. Clone the repository:
```bash
git clone https://github.com/KDM-cli/kdm-cli.git
cd kdm-cli
```
2. Install the dependencies:
```bash
npm install
```
3. To start the development watcher:
```bash
npm run dev
```
4. To run tests:
```bash
npm run test
```

## Coding Style

Please ensure your code is idiomatic and follows the existing TypeScript conventions in the codebase.
24 changes: 24 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Security Policy

## Supported Versions

We currently support the following versions of KDM-CLI with security updates:

| Version | Supported |
| ------- | ------------------ |
| >= 1.2.0| :white_check_mark: |
| < 1.2.0 | :x: |

## Reporting a Vulnerability

Security is a top priority for us. If you discover a security vulnerability within KDM-CLI, please do not disclose it publicly or open a public GitHub issue.

Instead, please send an email to the project maintainers or report it privately via GitHub's vulnerability reporting feature if enabled on the repository.

Please include the following information in your report:
- A detailed description of the vulnerability.
- Steps to reproduce the issue.
- Potential impact of the vulnerability.
- Any suggested fixes or mitigations (if applicable).

We will review your report and respond as quickly as possible. We aim to acknowledge receipt of the vulnerability within 48 hours and provide a timeline for resolution. Once the issue has been resolved, we will publish a security advisory and an update for the affected versions.
Loading