First of all, thank you for considering to contribute! 🙏🎉
The following is a set of guidelines for contributing to the publish-vscode-extension. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
To report a 🐛 please file an issue using the bug template. Please fill out the template tediously and provide information as detailed as possible. Include screenshots or GIFs to visualize the problem.
To suggest an enhancement please file an issue using the feature request template. Please fill out the template tediously and provide information as detailed as possible. The template will ask you for all relevant information.
Before starting to code please ensure you explicitly address an issue and comment on that issue indicating that you are working on it.
It would be a shame to reject a PR with your awesome work just because somebody else was faster or due to the lack of an issue.
First you need to fork the repo, clone it and install all dependencies.
# Use node v16
nvm install 16
# Clone the repository
git clone [email protected]:yourUserName/publish-vscode-extension.git
cd publish-vscode-extension
# Install the dependencies
npm i
# Open the project with VS Code
code .When you open the project the first time with VS Code the editor will ask you to install all recommended workspace extensions. Confirm that dialog and you are all set up.
The repo is setup to work out of the box. To start debugging just navigate in VS Code to the debug view and start the debug configuration of your choice.
If you are new to VS Code and typescript check out the official documentation to get started.
- When you made changes please also always commit the files in
dist/directory. - When you introduce new parameters do not forget to extend the
action.ymlfile.
Please follow these steps to have your contribution considered:
- Reference the issue you are working on e.g.:
Fixes #1 - Add information on how you solved the issue.
- After you submit your pull request, verify that all status checks are passing.
After your pull request was submitted and the status checks pass I will review your changes. I may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
publish-vscode-extension organizes its documentation in its README file. When contributing new features please extend the README as well as the CHANGELOG correspondingly. Please ensure you opened an issue beforehand which provides an explanation of the changes you want to propose to the wiki. After that you can fork the wiki and submit a pull request to address that issue.