Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 2.69 KB

Contributing to LeetSync

Thank you for considering contributing to LeetSync! Whether you want to report a bug, suggest an improvement, or submit a code change, your contributions are greatly appreciated.

Before contributing, please take a moment to read through the guidelines in this document.

Table of Contents

Reporting Bugs

If you encounter any bugs or issues with LeetSync, please open an issue on the GitHub repository with a clear description of the problem, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)

Suggesting Improvements

If you have a suggestion for improving LeetSync, please open an issue on the GitHub repository with a clear description of your idea. Please provide as much detail as possible, including:

  • The problem your suggestion solves
  • How your suggestion solves the problem
  • Potential drawbacks or trade-offs of your suggestion

Contributing Code

If you want to contribute code to LeetSync, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch for your changes.
  3. Make your changes in the new branch.
  4. Test your changes thoroughly.
  5. Commit your changes with clear and concise commit messages.
  6. Submit a pull request to the main repository.

Please make sure to adhere to the following guidelines when contributing code:

  • Follow the existing code style and formatting.
  • Include clear and concise documentation for any new or changed functionality.
  • Write unit tests for any new or changed functionality.

Running LeetSync Locally

To run LeetSync locally, follow these steps:

  1. Clone the repository to your local machine.
  2. Open Google Chrome and navigate to the chrome://extensions/ page.
  3. Toggle on Developer mode in the top right corner.
  4. Run yarn build in your project directory
  5. Click on the "Load unpacked" button and select the build folder.
  6. The LeetSync extension should now appear in your list of installed extensions.

Code of Conduct

LeetSync follows the Contributor Covenant code of conduct. Please review the code of conduct before contributing.

License

By contributing to LeetSync, you agree that your contributions will be licensed under the MIT License.