-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update process for infrastructural proposals (#131)
This updates the process docmentation and adds a new template for describing infrastructural proposals. This will allow us to use this process format for desigining project infrastructure and implementation details within the tooling that may not have language or other user exposure.
- Loading branch information
1 parent
25d2e88
commit db6623f
Showing
3 changed files
with
106 additions
and
10 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Current Active Proposals | ||
|
||
{% assign doclist = site.pages | sort: 'url' %} | ||
{% for doc in doclist %} | ||
{% if doc.name contains '.md' and doc.dir == '/proposals/' and doc.name != 'index.md' %} | ||
* [{{ doc.name }}]({{ doc.url | relative_url }}) | ||
{% endif %} | ||
{% endfor %} |
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 |
---|---|---|
@@ -0,0 +1,76 @@ | ||
<!-- {% raw %} --> | ||
|
||
# Feature name | ||
|
||
## Instructions | ||
|
||
> This template wraps at 80-columns. You don't need to match that wrapping, but | ||
> having some consistent column wrapping makes it easier to view diffs on | ||
> GitHub's review UI. Please wrap your lines to make it easier to review. | ||
> When filling out the template below for a new feature proposal, please do the | ||
> following first: | ||
> 1. exclude the "Planned Version", "PRs" and "Issues" from the header. | ||
> 2. Do not spend time writing the "Detailed design" until the feature has been | ||
> merged in the "Under Consideration" phase. | ||
> 3. Delete this Instructions section including the line below. | ||
--- | ||
|
||
* Proposal: [NNNN](NNNN-filename.md) | ||
* Author(s): [Author 1](https://github.com/author_username) | ||
* Sponsor: TBD | ||
* Status: **Under Consideration** | ||
* Impacted Project(s): (DXC, Clang, etc) | ||
|
||
*During the review process, add the following fields as needed:* | ||
|
||
* PRs: [#NNNN](https://github.com/microsoft/DirectXShaderCompiler/pull/NNNN) | ||
* Issues: | ||
[#NNNN](https://github.com/microsoft/DirectXShaderCompiler/issues/NNNN) | ||
|
||
## Introduction | ||
|
||
10,000 ft view of the change being proposed. Try to keep to one paragraph and | ||
less than 10 sentences. | ||
|
||
## Motivation | ||
|
||
Describe the problems users are currently facing that this feature addresses. | ||
Include concrete examples, links to related issues, and any relevant background. | ||
|
||
The point of this section is not to convince reviewers that you have a solution, | ||
but rather that a problem needs to be resolved. | ||
|
||
## Proposed solution | ||
|
||
Describe your solution to the problem. Provide examples and describe how they | ||
work. Show how your solution is better than current workarounds: is it cleaner, | ||
safer, or more efficient? | ||
|
||
## Detailed design | ||
|
||
_The detailed design is not required until the feature is under review._ | ||
|
||
This section should grow into a specification that will live in the | ||
specifications directory once complete. Each feature will need different levels | ||
of detail here, but some common things to think through are: | ||
|
||
* Is there any potential for changed behavior? | ||
* Will this expose new interfaces that will have support burden? | ||
* How will this proposal be tested? | ||
* Does this require additional hardware/software/human resources? | ||
|
||
## Alternatives considered (Optional) | ||
|
||
If alternative solutions were considered, please provide a brief overview. This | ||
section can also be populated based on conversations that occur during | ||
reviewing. | ||
|
||
## Acknowledgments (Optional) | ||
|
||
Take a moment to acknowledge the contributions of people other than the author | ||
and sponsor. | ||
|
||
<!-- {% endraw %} --> |