Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.27 KB
Raw

NoteX Contributor Guidelines

Welcome! Follow these guidelines for a smooth collaboration.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
    • Reporting Bugs
    • Feature Requests
    • Submitting Code
  3. Development Setup
  4. Pull Request Guidelines
  5. Code Style Guidelines
  6. Issue Management
  7. Contact

Code of Conduct

Adhere to the Contributor Covenant Code of Conduct. Be respectful and inclusive.

How to Contribute

Reporting Bugs

  • Search issues for existing reports.
  • Open a new issue with detailed reproduction steps if not found.

Feature Requests

  • Open a feature request in the issues section with your idea and use cases.

Submitting Code

  1. Fork the repo and create a new branch (git checkout -b feature-branch).
  2. Implement changes following code style guidelines.
  3. Ensure all tests pass.
  4. Commit with a clear message (git commit -m "Add feature XYZ").
  5. Push your branch (git push origin feature-branch).
  6. Submit a pull request (PR) and reference relevant issues.