Skip to content

Commit

Permalink
Adds Contributing Guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam-it committed May 19, 2024
1 parent 251e294 commit 8c45582
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contribution guidelines

Thank you for your interest in contributing to the PnP PowerShell VS Code extension. In this guide, we will walk you through the steps to get started.

## 👉 Before you start

In order to help us process your contributions, please make sure you do the following:

- don't surprise us with big PR's. Instead create an issue & start a discussion so we can agree on a direction before you invest a large amount of time.
- create your branch from `main`. This will make it easier for us to merge your changes.
- submit PR to the `main` branch of this repo. PRs submitted to other branches will be declined.
- let us know what's in the PR: sometimes code is not enough and in order to help us understand your awesome work please follow the PR template to provide required information.
- don't commit code you didn't write. Sure Copilot may help 😉.

Do not be afraid to ask question. We are here to help you succeed in helping us making a better product.

## 👣 How to start - Minimal path to awesome

- Fork this project.
- Clone the forked repository
- In the cloned repository, run the npm install command: `npm i`. Please be aware the recommended node version is 18.17.X or higher.
- Open the project in Visual Studio Code
- Run the build command: `npm run vscode:prepublish`
- Press `F5` to start the extension

## ❓ More guidance and tips

For more contributing guidance and tips and technical documentation of this extension please go to the repo [wiki](https://github.com/pnp/vscode-pnp-powershell/wiki).
20 changes: 20 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Support

Here you may find how to get support for PnP PowerShell VS Code extension.

## 🧾 Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.


## 🙏 Asking for help

There are a few different ways to ask for help:

1. Use **GitHub Issues** to report bugs or request a new feature 👉[Issues](https://github.com/pnp/vscode-pnp-powershell/issues/new/choose) section of this repository.
3. Use **Discord** to chat with the community and the maintainers 👉 [Discord](https://aka.ms/community/discord)

## 🙋‍♂️ Contributing

If you would like to contribute to PnP PowerShell VS Code extension, please read our [contributing guide](./CONTRIBUTING.md).

0 comments on commit 8c45582

Please sign in to comment.