Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (28 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.1 KB

Contributing to Witcher

Thank you for your interest in contributing to Witcher! 🚀 We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code contributions.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine:
$ git clone https://github.com/your-username/witcher.git
$ cd witcher
$ npm i
  1. Create a Feature Branch
$ git checkout -b feature-your-change

Coding Guidelines

  • Follow standard coding best practices and maintain clean, readable code.
  • Ensure security best practices are followed.
  • Run linter and formatter before submitting:

Submitting a Pull Request (PR)

  • Go to the Witcher repository on GitHub.
  • Click New Pull Request and select your branch.
  • Provide a clear description of the changes.
  • Ensure all CI checks pass before requesting a review.

Reporting Issues

If you find a bug or have a feature request, please open an issue:

  • Use a clear and descriptive title.
  • Provide steps to reproduce (for bugs).
  • Suggest possible solutions or workarounds.