Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

80 lines (57 loc) · 3.39 KB

Contributing to Auto Closing Tags for VS Code

Thank you for considering contributing to the Auto Closing Tags extension for Visual Studio Code! We appreciate your interest in improving the extension and making it more useful for developers.

How Can I Contribute?

There are many ways you can contribute to this project:

  1. Bug Reports: If you find a bug or issue with the extension, please open an issue on GitHub. Make sure to provide as much detail as possible, including steps to reproduce the issue.
  2. Feature Requests: If you'd like to see new features or additional snippets in the extension, open an issue with your suggestion, and we will review it.
  3. Pull Requests: You can submit your changes by forking the repository, creating a new branch, and submitting a pull request. We'll review your PR and merge it if it fits the project's goals.

Prerequisites

To contribute to this project, you need the following:

  • Visual Studio Code: The editor for which the extension is being developed.
  • Node.js: Make sure Node.js is installed on your machine. You can download it from nodejs.org.
  • Git: You'll need Git to clone the repository and submit your changes.

If you would like to add more snippets or improve the extension, feel free to fork the repository, make changes, and submit a pull request.

Steps to Contribute:

  1. Fork the repository.
  2. Clone your fork:
git clone https://github.com/Codegyan-LLC/Auto-Closing-Tags.git
  1. Create a new branch: Before making any changes, create a new branch for your work. Be descriptive about the changes you're going to make.
git checkout -b feature-name
  1. Make your changes : Now, you can start making changes to the code. You can:
  • Add new Auto Closing Tags.
  • Modify existing Code.
  • Update documentation like the README.md or add new sections for future features.
  1. Test the Extension After making your changes, test the extension locally by running it in VS Code:

Press F5 in VS Code to open a new window with your extension loaded. In the new window, open and test the extension you've added or modified.

  1. Commit your changes:
git commit -m "Added New Closing Tags"
  1. Push to your fork:
git push origin feature-name
  1. Open a Pull Request Go to your forked repository on GitHub and click Compare & Pull Request.

Provide a clear description of what you've changed and why. If you're fixing a bug, mention the issue number.

  1. Code Review Once your pull request is submitted, the project maintainers will review your changes. If necessary, they will suggest modifications. After the review process, your changes will be merged into the main branch.

Code Style

  1. Make sure your code is well-formatted and follows consistent style.
  2. Please add appropriate comments where needed, especially for complex code.
  3. Ensure your code doesn't break existing features by thoroughly testing it.

Reporting Issues

If you encounter any problems or bugs while using the extension, please report them on the GitHub Issues page. Include the following information:

  1. A detailed description of the issue.
  2. Steps to reproduce the issue.
  3. The environment (VS Code version, OS, etc.).
  4. Screenshots, if applicable.

Thank you for helping to make the Advanced Auto Closing Tags extension better! If you have any questions or need help, feel free to ask on the GitHub Discussions page.