How to contribute to PWABuilder

Welcome

Welcome to the PWABuilder Contribution Guide. These pages are primarily intended for those who wish to contribute to the project by submitting bug reports, suggesting new features, commenting on new ideas, or even by submitting pull requests.

Please refer to the sidebar (on the right) for details on Contributing.

##Code of Conduct This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

##Contributing to PWABuilder

If you are not sure how you can contribute to the site, start with our issues. Issues labeled help wanted are good issues to submit a PR for. If you are contributing significant changes, please discuss with the assignee of the issue first before starting to work on the issue.

Once you are ready to do your first contribution, follow these steps to get setup for contributing code to the PWABuilder!

• Setup the development environment
• Clone and build the project
• Develop
• Git workflow
• Submitting a pull request and participating in code review
• Quality assurance for new features For more advanced topic, see the nav bar on the right.

##Setup the development environment

Before cloning the repository, make sure you've installed the following prerequisites

###Required (in this order) Git (latest version)

Node.JS nodejs v12 or nodejs v14 is supported.

Yarn

in your favorite shell, run npm install -g yarn

Recommended VS Code (or your favorite code editor)

We also recommend to install the workplace recommended extensions once you've opened the cloned project in vscode.

#Developing There are several ways to "run" the project and test your changes. All have pros and cons and you might find using a combination of these as you are developing and testing changes. > yarn start