-
Notifications
You must be signed in to change notification settings - Fork 312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganize developer documentation #2576
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
232e200
Move navconfig.md
krschau 882c2d3
Update roadmap
krschau 2d0e144
update tools
krschau d78693e
move stuff around
krschau 99f5516
Delete src/readme.md copied from TemplateStudio
krschau 7d04365
Update architecture links
krschau 7913bbc
remove duplicated content between readme and contributing
krschau 763165c
move build instructions into contributing
krschau e5348c7
add common adaptive card schema coming soon
krschau 92d527b
Split up Tools page
krschau 341ca05
update extensions readme
krschau f93931d
update environments
krschau 92ad946
remove en-us from microsoft.learn links
krschau File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,62 +1,7 @@ | ||
# Dev Documentation | ||
|
||
## Fork, Clone, Branch and Create your PR | ||
|
||
Once you've discussed your proposed feature/fix/etc. with a team member, and you've agreed on an approach or a spec has been written and approved, it's time to start development: | ||
|
||
1. Fork the repo if you haven't already | ||
1. Clone your fork locally | ||
1. Create & push a feature branch <!--1. Create a [Draft Pull Request (PR)](https://github.blog/2019-02-14-introducing-draft-pull-requests/)--> | ||
1. Work on your changes | ||
|
||
## Rules | ||
|
||
- **Follow the pattern of what you already see in the code.** | ||
- [Coding style](style.md). | ||
- Try to package new ideas/components into libraries that have nicely defined interfaces. | ||
- Package new ideas into classes or refactor existing ideas into a class as you extend. | ||
- When adding new classes/methods/changing existing code: add new unit tests or update the existing tests. | ||
<!-- | ||
## GitHub Workflow | ||
|
||
- Before starting to work on a fix/feature, make sure there is an open issue to track the work. | ||
- Add the `In progress` label to the issue, if not already present also add a `Cost-Small/Medium/Large` estimate and make sure all appropriate labels are set. | ||
- If you are a community contributor, you will not be able to add labels to the issue, in that case just add a comment saying that you started to work on the issue and try to give an estimate for the delivery date. | ||
- If the work item has a medium/large cost, using the markdown task list, list each sub item and update the list with a check mark after completing each sub item. | ||
- When opening a PR, follow the PR template. | ||
- When you'd like the team to take a look, (even if the work is not yet fully-complete), mark the PR as 'Ready For Review' so that the team can review your work and provide comments, suggestions, and request changes. It may take several cycles, but the end result will be solid, testable, conformant code that is safe for us to merge. | ||
- When the PR is approved, let the owner of the PR merge it. For community contributions the reviewer that approved the PR can also merge it. | ||
- Use the `Squash and merge` option to merge a PR, if you don't want to squash it because there are logically different commits, use `Rebase and merge`. | ||
- We don't close issues automatically when referenced in a PR, so after the PR is merged: | ||
- mark the issue(s), that the PR solved, with the `Resolution-Fix-Committed` label, remove the `In progress` label and if the issue is assigned to a project, move the item to the `Done` status. | ||
- don't close the issue if it's a bug in the current released version since users tend to not search for closed issues, we will close the resolved issues when a new version is released. | ||
- if it's not a code fix that affects the end user, the issue can be closed (for example a fix in the build or a code refactoring and so on). | ||
--> | ||
## Compiling Dev Home | ||
|
||
### Compiling Source Code | ||
|
||
There are two ways to compile locally. | ||
|
||
- Open the Developer Command Prompt for Visual Studio | ||
- Run `Build` from Dev Home's root directory. You can pass in a list of platforms/configurations | ||
- The Dev Home MSIX will be in your repo under `AppxPackages\x64\debug` | ||
|
||
Alternatively | ||
|
||
- Open `DevHome.sln` in Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` or `Debug`, from the `Build` menu choose `Build Solution`. | ||
|
||
### Dev Home framework | ||
|
||
The Dev Home project contains the wrapping framework for Dev Home. | ||
It's responsible for: | ||
- Loading the individual Dev Home tools. | ||
- Loading out-of-process extensions. | ||
- Loading the main window and creating a skeleton UI. | ||
|
||
|
||
## More | ||
|
||
Before you dive into developing for Dev Home, check out these resources: | ||
- [Dev Home Architecture](./architecture.md) | ||
- [Dev Home Tools](./tools.md) | ||
- [Dev Home Extensions](./extensions.md) | ||
- [Dev Home Tools](./tools/readme.md) | ||
- [Dev Home Extensions](./extensions/extensions.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
docs/sampleConfigurations/Templates/Introduction/C#/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
docs/sampleConfigurations/Templates/Introduction/C++/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the extra whitespace needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it keeps the rectangle of #s a rectangle.