Merge CONTRIBUTING.md into website contributing guide. #15449
Merged
Conversation
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
ScottTodd
commented
Nov 7, 2023
Comment on lines
104
to
106
| ### :octicons-git-merge-16: Obtaining commit access | ||
|
|
||
| !!! note "TODO(jpienaar): write this :)" |
There was a problem hiding this comment.
(I can also write this once you have the form ready to link to)
Should maybe also add a link to that in https://github.com/openxla/community ?
ScottTodd
force-pushed
the
contributing-guide
branch
from
cf27a12 to
f3e9c40
Compare
stellaraccident
approved these changes
Nov 9, 2023
stellaraccident
approved these changes
Nov 9, 2023
ScottTodd
commented
Nov 9, 2023
| someone else to merge it for them (e.g. because they don't have write access | ||
| yet). | ||
|
|
||
| ### :octicons-git-merge-16: Obtaining commit access |
There was a problem hiding this comment.
Wrote this section :)
Live preview: https://scotttodd.github.io/iree/developers/general/contributing/#obtaining-commit-access
The form goes to Jacques to review access requests
ramiro050
pushed a commit
to ramiro050/iree
that referenced
this pull request
Dec 19, 2023
Following up on some ideas noted at iree-org#15116 (comment). We had previously split "contributing" docs between the root `CONTRIBUTING.md` and a separate developer doc. Now that the developer doc is published on our website at https://iree.dev/developers/general/contributing/, we can move more of the documentation there and just have the root file point at the website. Preview for review: https://scotttodd.github.io/iree/developers/general/contributing/ * I rewrote and reordered most of the sections * I have more ideas for how to streamline these docs... trying to not spent too much time on this right now though 😛 * Separate "infrastructure" page explaining how to interact with the CI (build/test/benchmark/etc.) * Deemphasize "contributor tips" and/or add more tips (like how to set up Visual Studio Code) I took some inspiration from https://llvm.org/docs/Contributing.html and https://llvm.org/docs/DeveloperPolicy.html.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Following up on some ideas noted at #15116 (comment).
We had previously split "contributing" docs between the root
CONTRIBUTING.mdand a separate developer doc. Now that the developer doc is published on our website at https://iree.dev/developers/general/contributing/, we can move more of the documentation there and just have the root file point at the website.Preview for review: https://scotttodd.github.io/iree/developers/general/contributing/
I took some inspiration from https://llvm.org/docs/Contributing.html and https://llvm.org/docs/DeveloperPolicy.html.