Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (69 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

92 lines (69 loc) · 2.08 KB

Contributing Guide

Thank you for your interest in contributing to this project!
All contributions are welcome — from bug reports and feature requests to code improvements and documentation updates.

This document explains how to contribute effectively and respectfully.

🧩 How You Can Contribute

1. Report Bugs

If you find a bug, please open an issue using the Bug Report template.
Include:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Logs, screenshots if helpful

2. Request Features

To propose new functionality, open an issue using the Feature Request template.
Describe:

  • The problem or need
  • The proposed solution
  • Alternatives you considered

3. Submit Pull Requests

We gladly accept PRs! Before submitting:

  1. Make sure there is an open issue describing your change — or create one.
  2. Fork the project and create a new branch: 
    git checkout -b feature/my-improvement
  3. Follow code style and formatting rules: 
    npm run lint
npm run format
  4. Add or update tests when needed.
  5. Ensure the PR title clearly describes the change.
  6. Submit the PR using the Pull Request Template.

🛠 Development Setup

  1. Clone the repository: 
    git clone https://github.com/Baskerville42/udid-tools.git
  2. Install dependencies: 
    npm install
  3. Start the development environment: 
    npm run dev

🔧 Coding Standards

  • Use TypeScript for all new code.
  • Follow the project structure and naming conventions.
  • Use ESLint and Prettier (auto-run via scripts).
  • Write clear, concise commit messages.

🧪 Testing

  • Add tests for all logic changes when practical.
  • Run tests before submitting a PR: 
    npm test

🤝 Code of Conduct

By participating, you agree to follow the Code of Conduct included in this repository.

📬 Questions?

If you have questions or need clarification:

  • Open a Discussion or Issue on GitHub.

Thank you for helping to improve this project!