Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (35 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 1.45 KB

Contributing to JackNotes

Thank you for your interest in contributing to JackNotes. It is because of contributors like you that JackNotes continues to improve and grow into a better tool.

Feature Contributions

If you plan to submit a PR for a new feature, please create an issue beforehand to discuss your proposal. Once the idea has been reviewed and agreed upon, you may proceed with development and submit your PR. This process helps ensure smoother feedback and an efficient review workflow.

Bug Fixes

If you would like to fix a bug, you may submit a PR directly. Please include a clear description of the issue you addressed and reference any related reports.

Development Plan

For more details about ongoing and upcoming work, please refer to:

Development Environment Setup

  1. Clone the repository:
    git clone https://github.com/jacksnotes/JackNotes.git

  2. Install dependencies:
    npm install

  3. Start development:
    npm run electron:serve

Commit Guidelines

  • Write clear and descriptive commit messages
  • Follow the existing code style and project conventions
  • Add tests for any new features

License

By contributing code, you agree that your contribution will be released under the MIT License.