improving readme and adding contributing page
This commit is contained in:
Yosef Durr
47
CONTRIBUTING.md
Normal file
47
CONTRIBUTING.md
Normal file
@@ -0,0 +1,47 @@
|
||||
Contributing to Windows Dev Box Setup Scripts
|
||||
|
||||
The goal for **Windows Dev Box Setup Scripts** is to help developers get their dev box up and going quickly.
|
||||
|
||||
## Before you begin
|
||||
|
||||
We're grateful for any and all contributions. Before you submit a PR we ask that you consider the following points.
|
||||
|
||||
* Please create or comment on an existing issue to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it also enables the community to discuss the particulars with you. It's less work for everyone, in the long run, to establish this up front.
|
||||
* When adding to a setup script, the addition should be useful to the majority of developers working with the dev stack the script is intended for.
|
||||
|
||||
|
||||
## A good pull request
|
||||
|
||||
Every contribution has to come with:
|
||||
|
||||
* Before making the change, **please open an issue** or comment on an existing issue, and start discussing with the community to see if the idea/feature is interesting enough.
|
||||
|
||||
* For both new scripts and script changes please test the entire script on Windows 10.
|
||||
|
||||
The core team will test the change to validate it before merging it.
|
||||
|
||||
|
||||
## Repository Structure
|
||||
|
||||
Scripts are named with dev_[MAJOR_AREA]_[MINORAREA].
|
||||
The Minor Area is optional. Currently the scripts are completely self contained - there is no script chaining. It would be useful to move to a tree model, and we'll update these instructions if/when that happens.
|
||||
|
||||
Examples
|
||||
- dev_web_nodejs
|
||||
- dev_app_android
|
||||
- dev_ml
|
||||
|
||||
Current Major Areas
|
||||
- web
|
||||
- app
|
||||
- ml (machine learning)
|
||||
- iot
|
||||
- backend
|
||||
|
||||
Minor Area is open
|
||||
|
||||
If you have a change request for Major Area please let us know by filing an issue.
|
||||
|
||||
If the script has additional steps please create a folder for your script and include a Readme with these instructions.
|
||||
|
||||
Thank you!
|
||||
52
README.md
52
README.md
@@ -1,42 +1,38 @@
|
||||
|
||||
# About this project
|
||||
This project contains sample scripts and tips for setting up a Windows development machine.
|
||||
The goal of this porject is to provide a central place to share ideas for streamlining dev box setup and give you starting point ideas. It's likely you will want to take scripts here and modify them to fit your particular needs. When you make those changes if you think others would benefit please consider submitting a PR. Before you contribute please see the [Contribution Guidelines](CONTRIBUTING.md).
|
||||
|
||||
These scripts leverage two popular projects
|
||||
These scripts leverage two popular open source projects.
|
||||
- Boxstarter [boxstarter.org](http://boxstarter.org)
|
||||
- Chocolatey [chocolatey.org](http://chocolatey.org)
|
||||
|
||||
This project exists because we noticed scripts and tips showing up in different open source projects and thought it would be useful to have a central place for collaborating on setup scripts.
|
||||
|
||||
The goal here is to provide a central place to share ideas for streamlining dev box setup and give you starting point ideas. It's likely you will want to take scripts here and modify them to fit your particular needs. When you make those changes if you think others would benefit please consider submitting a PR here. Before you contribute please see the contribution guidelines.
|
||||
|
||||
## Script naming convention
|
||||
The "dev_" scripts are named according to developer scenario.
|
||||
|
||||
## How to run the scripts
|
||||
Links will be provided here in the readme<br/>
|
||||
Click the link and you'll see a prompt for boxstarter click once. Click yes and the system setup will begin!
|
||||
Before you begin, please read the [Read Before You Run](#read-this-before-you-run) section.
|
||||
|
||||
An example to try is click this should work for the NodeJS script:<br/>
|
||||
http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_web_nodejs.ps1?token=AK0OHg--lXI4lmyAFY_wN2CKxWnUaaSRks5a8VJjwA%3D%3D
|
||||
To run a script click a link in the table below. This will download Boxstarter, and prompt you for Boxstarter to run with Administrator privileges (which it needs to do its job). Clicking yes in this dialog will cause the script to begin. You can then leave the job unattended and come back when it's finished.
|
||||
|
||||
## Working with Enterprise Chocolatey?
|
||||
No problem, you can still use this scripts. Before you do you'll need to modify the package source to match your enterprise package store. Here are instructions for doing so.
|
||||
|Link |Description |
|
||||
|---------|---------|
|
||||
| | Desktop App Development (Visual Studio, Windows SDK) |
|
||||
| | Xamarin (Visual Studio, Xamarin, Android SDK) |
|
||||
| | Web (VS Code, Multiple Browsers) |
|
||||
|<a href='http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_web_nodejs.ps1?token=AK0OHg--lXI4lmyAFY_wN2CKxWnUaaSRks5a8VJjwA%3D%3D'>Web_NodeJS</a> | Web Dev with NodeJS (Web + NodeJS LTS) |
|
||||
| | Machine Learning |
|
||||
| | Containers (Kubernetes, etc...) |
|
||||
|
||||
|
||||
## Read this before you run
|
||||
[BEN]
|
||||
|
||||
## Working with Chocolatey for Organizations?
|
||||
No problem, you can still use these scripts. You'll need to modify the script to reference your internal package store. Here are instructions for doing so:
|
||||
|
||||
[ADD INSTRUCTIONS]
|
||||
|
||||
## Setting up a VM
|
||||
Windows 10 VM setup instructions
|
||||
1. Insert Quick create steps here
|
||||
2. Include steps once signed in to your VM
|
||||
1. Use Quick Create to set up a VM
|
||||
2. Once signed in to your VM, browse to this project and click a script link in the table of scripts
|
||||
|
||||
# Contributing
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
||||
|
||||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
|
||||
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
|
||||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||||
|
||||
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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
Do you want to contribute? We would love your help. Here are our <a href="CONTRIBUTING.md">contribution guidelines</a>.
|
||||
|
||||
Reference in New Issue
Block a user