Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

93 lines (61 loc) · 3.48 KB

Contributing to UqmiClient

Thank you for considering contributing to this project! We welcome all types of contributions, whether it's reporting bugs, suggesting features, writing code, or improving documentation.

Table of Contents

Code of Conduct

Please read and adhere to our Code of Conduct to ensure a welcoming and friendly environment for all contributors.

Security Policy

If you discover a security vulnerability, please review our Security Policy for instructions on how to responsibly disclose it.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue and provide as much detail as possible:

  • Steps to reproduce the bug
  • Expected and actual behavior
  • Environment details (e.g., OS, Node.js version)

Make sure to search existing issues first to avoid duplicates.

Suggesting Features

To suggest a new feature or improvement, open an issue and describe:

  • The problem you're facing or the enhancement you'd like to see
  • Any possible solutions or ideas for how to implement it

Submitting Code Changes

  1. Fork the repository: Click the "Fork" button at the top right.
  2. Clone your fork: git clone https://github.com/benjamin-stefan/auqmi-client.git
  3. Create a new branch: git checkout -b feature/my-new-feature
    • Use descriptive branch names like feature/add-new-feature or fix/bug-123.
  4. Make your changes: Add your code or documentation.
  5. Follow the commit guidelines: Use the Conventional Commits format, e.g., git commit -m 'feat: add new feature'.
  6. Push your changes: git push origin feature/my-new-feature
  7. Open a Pull Request: Go to the original repository and submit a Pull Request (PR) with a detailed description of your changes.

Development Workflow

Local Setup

  1. Clone the repository: git clone https://github.com/Benjamin-Stefan/antuqmi-client.git
  2. Install dependencies: npm install

Testing

  • Run all tests: npm test

Ensure that all tests pass before submitting a PR.

Pull Request Guidelines

  • Description: Provide a clear and concise description of the changes.
  • Reference Issues: Link any related issues in the PR description (e.g., "Fixes #123").
  • Checklist:
    • Code adheres to the style guidelines (npm run lint).
    • All tests pass.
    • Documentation has been updated if necessary.
    • Changes are backward compatible.

Getting Help

If you need help or have questions, feel free to:

License

By contributing, you agree that your contributions will be licensed under the same license as the project (MIT License).

Thank You!

Your contributions make this project better for everyone. Thank you!