Add code dev overview page and make a few minor updates. (#51)

This commit is contained in:
Sean Brogan 2018-12-19 20:18:28 -08:00 коммит произвёл GitHub
Родитель 2b5fb5961f
Коммит 223299a029
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
7 изменённых файлов: 22 добавлений и 12 удалений

Просмотреть файл

@ -1,4 +1,21 @@
# Code Development Overview
*Todo*
## Tools
First you will need to setup your UEFI development environment. Project Mu leverages most of the tools from _TianoCore EDK2_. We have streamlined the process for the tool chains and systems we use but our project's goals are to support various tool chains and development environments. For the best experience or for those new to UEFI and Project Mu we have provided guidance in our [prerequisites](/CodeDevelopment/prerequisites) page.
## Code
Next you will need to clone a repository or set of repositories to work on.
For __core__ work (Project Mu Repos) you can clone the desired repo, make your changes, run CI builds, run your tests, and submit a PR.
For __platform__ work (outside of Project Mu) you will need to clone the platform repository and then follow the platform setup process.
See details on the [compile](/CodeDevelopment/compile) page for more information about CI builds and how to compile a package or platform.
Code should follow best practices. We are working to add some best practices on the [requirements](/CodeDevelopment/requirements) page. We also attempt to enforce these best practices thru our CI build process.
## Tests
One area of focus for Project Mu is on testing. Firmware testing has traditionally been hard and very manual. We hope to describe techniques and provide resources to make this easier and more automated. Testing needs to be part of the code development process. Check out the [testing](/CodeDevelopment/test) page for more details.

Просмотреть файл

@ -39,4 +39,6 @@
2. Use STATIC on each non-public function and non-public global to avoid conflicts with other modules.
3. Use EFIAPI on all public library class functions.
## More info
For general Edk2 and UEFI development additional information can be found at the [TianoCore.org](https://www.tianocore.org/) website.

Просмотреть файл

@ -1,6 +1,6 @@
# Tests
Testing firmware is hard. Lets just stop there. :poop: If you want to read on please do at your own risk. Project Mu supports a few types of testing and this page will help provide some high level info and links for more information.
Testing firmware is hard. Lets just stop there. :sob: If you want to read on please do at your own risk. Project Mu supports a few types of testing and this page will help provide some high level info and links for more information.
## Static Code Tests (analysis)

Просмотреть файл

@ -7,6 +7,7 @@
## Get the docs repository
First, you need to clone the project mu docs repository.
``` cmd
git clone https://github.com/Microsoft/mu.git
```

Просмотреть файл

@ -1,5 +0,0 @@
# Downstream Project Integration
Describe successful patterns for integrating downstream for Common, Silicon, and Platform layers.
Describe impacts of rebase process
Describe how to report back integration status and errors (automation)

Просмотреть файл

@ -1,3 +0,0 @@
# Upstream Integration
## Tianocore integration

Просмотреть файл

@ -51,9 +51,7 @@ nav:
- External Resources: 'Where/external_resources.md'
- How:
- Release Process: 'How/release_process.md'
- Downstream Integration: 'How/downstream_integration.md'
- Contributing: 'How/contributing.md'
- Upstream Integration: 'How/upstream_integration.md'
- Developing Docs:
- Overview: "DeveloperDocs/developer_docs.md"
- How To Build: "DeveloperDocs/build_community_docs.md"