Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.82 KB

File metadata and controls

39 lines (27 loc) · 1.82 KB

Contributing to CodeSense

We welcome contributions from the community! Whether you're a developer, a designer, or just a web enthusiast, there are many ways to contribute to CodeSense.

How to Contribute

  • Reporting Bugs: If you find a bug, please open an issue on our GitHub repository. Be sure to include a clear description of the bug, steps to reproduce it, and any relevant error messages.
  • Suggesting Enhancements: If you have an idea for a new feature or an improvement to an existing one, please open an issue on our GitHub repository. We'd love to hear your ideas!
  • Writing Code: If you're a developer, you can contribute by writing code to fix bugs or implement new features. See the "Development Setup" section below for instructions on how to get started.
  • Improving Documentation: If you find any errors or omissions in our documentation, please open an issue or submit a pull request to fix it.

Development Setup

  1. Fork the repository: Click the "Fork" button on the top right of the repository page.
  2. Clone your fork: git clone https://github.com/your-username/CodeSense.git
  3. Install dependencies: cd CodeSense && npm install
  4. Compile the code: npm run compile

Running Tests

To run the test suite, use the following command:

npm test

Submitting Pull Requests

  1. Create a new branch for your changes: git checkout -b my-new-feature
  2. Make your changes and commit them: git commit -am 'Add some feature'
  3. Push your changes to your fork: git push origin my-new-feature
  4. Open a pull request on the main CodeSense repository.

When submitting a pull request, please make sure to:

  • Include a clear description of the changes you've made.
  • Reference any related issues.
  • Make sure the test suite passes.
  • Follow the existing code style.