Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.46 KB

CONTRIBUTE.md

File metadata and controls

60 lines (37 loc) · 2.46 KB
Raw

🌟 Contributing to Snippy

Welcome aboard, fellow code traveler! 🚀 We appreciate your interest in contributing to the Snippy extension. Your collaboration and contributions are essential to making this project a success. This document outlines the guidelines and best practices for contributing to the project.

🤝 Code of Conduct

Please review and follow our Code of Conduct to ensure a welcoming and inclusive environment for all contributors.

🐛 Reporting Issues

Before submitting a new issue, please check the existing Issues to avoid creating duplicates. When reporting a new issue, provide as much detail as possible, including steps to reproduce the problem, error messages, and any relevant screenshots or logs.

🔧 Pull Requests

  1. Fork the repository and create a new branch for your feature or bugfix.
  2. Follow the established coding style and conventions used in the project.
  3. Write clear and concise commit messages describing the changes you've made.
  4. Ensure your changes are adequately covered by unit tests.
  5. Update the documentation as necessary to reflect your changes.
  6. Submit a pull request to the dev branch of the original repository.
  7. Address any feedback or requested changes from the project maintainers.

💻 Development Environment Setup

To set up your development environment, follow these steps:

Install dependencies

  • NodeJS LTS (v18.14.2 as of writing)
  • Yarn >= 1.22.19

Clone the repository

git clone https://github.com/Dave-Wagner/Snippy.git

Install dependencies

yarn install

Run tests

yarn test

Open the project in Visual Studio Code. Run the yarn compile command to build the project. Use the "Run Extension" option in Visual Studio Code to launch a new Extension Development Host with your changes.

Testing

Before submitting your changes, ensure that all tests pass by running the yarn test command. Add new tests as needed to cover any additional functionality or bug fixes introduced by your changes.

📚 Documentation

Keep the documentation up-to-date and accurate. Update the README, CHANGELOG, and other relevant documentation files as needed when adding new features or making changes to the extension's behavior.

Thank you for your interest in contributing to Snippy! Your time and effort are greatly appreciated, and we look forward to collaborating with you to improve the project. 🎉