github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-01-09 14:48:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

corrected typo in contributing.md (#2334)

Browse Source 
* Added deleted sections to openmp.md and other improvements

* Update CONTRIBUTING.md

* add example of snake case

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>
This commit is contained in:
srawat
2023-08-05 00:16:13 +05:30
committed by GitHub
parent 45505e4912
commit 3bfce9c570
1 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@@ -38,10 +38,30 @@ as follows:
## Filenames and folder structure
Snake case is preferred for file names. Our documentation follows pitchfork for
folder structure. All documentation is in `/docs` except for special files like
Please use snake case (all lower case letters and underscores instead of spaces)
for file names. For example, `example_file_name.md`.
Our documentation follows pitchfork for folder structure.
All documentation is in `/docs` except for special files like
the contributing guide in the `/` folder. All images used in the documentation are
place in the `/docs/data` folder.
place in the /docs/data folder.
## How to provide feedback for ROCm documentation
There are three standard ways to provide feedback for this repository.
### Pull Request
All contributions to ROCm documentation should arrive via the
[GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)
targetting the develop branch of the repository. If you are unable to contribute
via the GitHub Flow, feel free to email us. TODO, confirm email address.
### GitHub Issue
Issues on existing or absent docs can be filed as [GitHub issues
](https://github.com/RadeonOpenCompute/ROCm/issues).
### Email Feedback
## Language and Style