Skip to content
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

Add documentation for design meetings #352

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/agenda_item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Design Meeting Agenda Item
about: Add an item to the next Design Meeting agenda
title: ''
labels: ['Design Meeting']
assignees: ['llvm-beanz', 'farzonl']

---

**Does the agenda item relate to an existing proposal or specification language?**
Please link the file in the repo where the problem is documented.

**Describe the issue or outstanding question.**
This can be as short as a question that needs answering or as complex as needed
to convey the problem that needs solving.

**Additional context**
Add any other context or screenshots about the feature request here.

7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Public Design Meeting

The HLSL team organizes a meeting every two weeks which is open to the public to discuss work in progress in this repository.
That includes proposals for new HLSL features as well as the ongoing work to write a language specification.

For more information on this meeting see the [Design Meeting](docs/DesignMeeting.md) documentation.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
Expand Down
36 changes: 36 additions & 0 deletions docs/DesignMeeting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Design Meeting

> Notice: By participating in this meeting you are agreeing that all
> contributions you make on your own behalf or on behalf of your employer are
> subject to the terms of the
> [Microsoft Open Source Contributor License Agreement](https://opensource.microsoft.com/cla/).

Public design meetings are held every other week (cancelling for holidays).
During these meetings the facilitator will iterate through PRs, issues and other
agenda topics to ensure forward progress and facilitate discussion.

The meetings are facilitated by [Chris Bieneman](https://github.com/llvm-beanz)
and [Farzon Lotfi](https://github.com/farzonl).

Meeting minutes will be posted into the [Meeting Minutes](docs/DesignMeetingMinutes)
folder of this repository following the [template](docs/DesignMeetingMinutes/Template.md).

## Adding Agenda Items

If there is an existing Issue or Pull Request you would like to discuss at the
next design meeting please add the
[Design Meeting](https://github.com/microsoft/hlsl-specs/labels/Design%20Meeting)
label. Issues and Pull Requests with the Design Meeting label will be given priority
during the meeting.

If there is not an existing Issue or Pull request. File an issue with the
[Design Meeting Agenda Item](https://github.com/microsoft/hlsl-specs/issues/new?template=agenda_item.md)
template.

## Attending the Meeting

The design meeting is held using Microsoft Teams.

If you wish to attend the meeting for an individual occurrence or on a recurring
basis, email [Ask HLSL @ Microsoft](mailto:[email protected]). Please
specify whether you want the recurring invite or a specific occurrence.
7 changes: 7 additions & 0 deletions docs/DesignMeetingMinutes/Template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Design Meeting Minutes: YYYY/MM/DD

> Notice: By participating in this meeting you are agreeing that all
> contributions you make on your own behalf or on behalf of your employer are
> subject to the terms of the
> [Microsoft Open Source Contributor License Agreement](https://opensource.microsoft.com/cla/).

8 changes: 8 additions & 0 deletions docs/DesignMeetingMinutes/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Meeting Minute Index

{% assign doclist = site.pages | sort: 'url' %}
{% for doc in doclist %}
{% if doc.name contains '.md' and doc.dir == '/docs/DesignMeetingMinutes/' and doc.name != 'index.md' %}
* [{{ doc.name }}]({{ doc.url | relative_url }})
{% endif %}
{% endfor %}