Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 3.14 KB

CONTRIBUTING.MD

File metadata and controls

55 lines (37 loc) · 3.14 KB

Contributing to TabNote

Thank you for your interest in contributing to TabNote! TabNote is a VS Code extension that allows you to leave notes on tabs and files. We welcome any kind of contribution, whether it is a bug report, a feature request, a code improvement, a documentation update, or anything else that can make TabNote better.

Code of Conduct

Please read and follow our Code of Conduct before you interact with our project. We expect everyone to respect each other and behave in a civil manner.

How to report bugs

If you encounter a bug while using TabNote, please open an issue on our GitHub repository. Before you do so, please check if there is already an existing issue that describes the same problem. If not, create a new issue and provide the following information:

  • A clear and descriptive title
  • A detailed description of the bug and how to reproduce it
  • The expected and actual behavior
  • The version of VS Code and TabNote you are using
  • Any relevant screenshots or error messages

How to request features

If you have an idea for a new feature or an improvement for TabNote, please open an issue on our GitHub repository. Before you do so, please check if there is already an existing issue that describes the same or similar feature. If not, create a new issue and provide the following information:

  • A clear and descriptive title
  • A detailed explanation of why you want this feature and how it would benefit TabNote users
  • Any relevant examples or mockups of how the feature would look or work

How to set up the development environment

If you want to contribute code to TabNote, you will need to set up the development environment first. Here are the steps:

  • Fork the TabNote repository on GitHub and clone your fork locally
  • Open the cloned folder in VS Code
  • Run npm install in the terminal to install the dependencies
  • Run npm run watch in the terminal to compile the TypeScript files
  • Press F5 to launch a new VS Code window with TabNote extension loaded

How to submit a pull request

If you have made some changes to TabNote code and want to merge them into the main branch, please follow these steps:

  • Create a new branch from the main branch and name it according to the feature or bug fix you are working on
  • Commit your changes with clear and concise messages
  • Push your branch to your forked repository on GitHub
  • Open a pull request from your branch to the main branch of TabNote repository
  • Provide a brief summary of what your pull request does and why it should be merged
  • Wait for feedback from maintainers or reviewers and address any comments or requests they may have

What kind of contributions are welcome

We appreciate any kind of contribution that can make TabNote better. Here are some examples of what you can do:

  • Fix bugs or errors in TabNote code n
  • Add new features or enhancements that improve TabNote functionality or usability
  • Write tests or improve test coverage for TabNote code
  • Update documentation or write tutorials for using TabNote features