Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (44 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 2.31 KB

Contributing to Polar

First off, thank you for considering contributing to Polar! It's people like you that make Polar such a great project.

We welcome any type of contribution, not just code. You can help with:

  • Reporting a bug: If you find a bug, please let us know.
  • Suggesting a feature: If you have an idea for a new feature, we'd love to hear about it.
  • Contributing code: If you want to write some code, we're happy to accept pull requests.
  • Improving documentation: If you see something that could be clearer, please let us know.

Getting Started

To get started, you'll need to have a GitHub account. You'll also need to have Node.js and pnpm installed on your machine.

  1. Fork the repository on GitHub.
  2. Clone your fork locally: git clone https://github.com/your-username/polar.git
  3. Navigate to the project directory: cd polar
  4. Install the dependencies: pnpm install
  5. Create a new branch for your changes: git checkout -b my-new-feature

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub. Please include as much detail as possible, including:

  • A clear and descriptive title.
  • A detailed description of the bug, including steps to reproduce it.
  • The expected behavior and what actually happened.
  • Your operating system and browser (if applicable).

Suggesting Features

If you have an idea for a new feature, please open an issue on GitHub. Please include:

  • A clear and descriptive title.
  • A detailed description of the feature you'd like to see.
  • Any mockups or screenshots that might help explain your idea.

Submitting Pull Requests

  1. Make your changes in your local repository.
  2. Commit your changes: git commit -m "feat: Add some new feature"
  3. Push your changes to your fork: git push origin my-new-feature
  4. Open a pull request on GitHub.

Please make sure your pull request includes:

  • A clear and descriptive title.
  • A detailed description of the changes you've made.
  • A reference to the issue you're addressing (if applicable).

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

License

By contributing to Polar, you agree that your contributions will be licensed under the Polar Restricted Use and Attribution License (P-RUAL).