Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (34 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 2.46 KB

Contributing to Personal Notion Manager

Welcome to Personal Notion Manager! We're excited that you're interested in contributing. Whether you're a seasoned developer or just starting out, your contributions are valuable to us. This document outlines the guidelines for contributing to our project.

Code of Conduct

Before you start contributing, please review our Code of Conduct. We expect all contributors to adhere to these guidelines to ensure a positive and inclusive community.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Set up your development environment. We recommend using Visual Studio Code.

Issues

  • Check the existing issues in the issue tracker to avoid duplicates.
  • If you find an issue you'd like to work on, comment on it to let others know.
  • If you have a new feature idea or you encounter a bug, feel free to open a new issue.

Contributing Code

  1. Create a new branch from the main branch: git checkout -b your-feature-branch.
  2. Write clean, modular, and well-documented TypeScript code.
  3. Follow our coding style guidelines.
  4. Write tests to cover new functionality or bug fixes.
  5. Run existing tests before submitting your changes: npm test.
  6. Commit your changes with a descriptive commit message.
  7. Push your changes to your fork: git push origin your-feature-branch.
  8. Create a pull request (PR) to the main branch of this repository.

Pull Requests

  • Provide a clear title and description for your PR.
  • Link related issues in the PR description using keywords like "Fixes #123".
  • If your PR requires any changes or updates, address the feedback provided.
  • Once your PR is approved, it will be merged into the main branch.

Documentation

  • If you add new features or modify existing ones, update the documentation accordingly.
  • Keep the README up to date with clear setup instructions, usage guidelines, and examples.

Reporting Security Issues

To be defined.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's license.

Thank you for contributing to Personal Notion Manager! Your time and efforts are highly appreciated.