npm-to-cdn
Version:
A CLI tool to get CDN links for any npm package.
42 lines (28 loc) • 1.21 kB
Markdown
# Contributing to npm-to-cdn
Thank you for your interest in contributing! Your help makes npm-to-cdn better for everyone.
## How to Contribute
- **Bug Reports & Feature Requests:**
- Open an issue on [GitHub Issues](https://github.com/TrialLord/npm-to-cdn/issues).
- Please provide clear steps to reproduce bugs or a detailed description of your feature request.
- **Pull Requests:**
- Fork the repository and create your branch from `main`.
- Write clear, focused commits and reference related issues.
- Ensure your code passes all tests and lints before submitting.
- Open a pull request and describe your changes.
## Coding Standards
- Use **TypeScript** for all source code.
- Follow the existing code style and formatting (use Prettier if available).
- Write clear, descriptive comments for complex logic.
## Running Locally
```sh
npm install
npm run build
```
## Running Tests
```sh
npm test
```
## Continuous Integration
All pull requests are automatically tested and linted via GitHub Actions. Please ensure your code passes before requesting review.
## Code of Conduct
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).