Merge branch 'openhwgroup:main' into main

This commit is contained in:
Cairo Caplan 2025-03-13 09:27:24 +01:00 committed by GitHub
commit 2d2f36aba5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,11 +1,19 @@
# Contributing
Contributors are encouraged to be a [member](https://www.openhwgroup.org/membership/) of the
OpenHW Group. New members are always welcome.
New Contributors and new Members are always welcome!
Although membership is not required, most Contributors are [members](https://openhwfoundation.org/membership/become-a-member/)
of the OpenHW Foundation and participate in one or more of our [Projects](https://openhwfoundation.org/projects/).
## Contributor Agreement
Contributors **must** be covered by the terms of the [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php)
(for individuals) **or** the [Eclipse Member Committer and Contributor Agreement](https://www.eclipse.org/legal/committer_process/EclipseMemberCommitterAgreement.pdf)
(for employees of Member companies). The ECA/MCCA provides a legal
framework for a Contributor's technical contributions to the OpenHW Foundation,
including provisions for grant of copyright license and a Developer
Certificate of Origin on contributions merged into OpenHW Foundation repositories.
## Getting Started
The [OpenHW Work Flow](https://github.com/openhwgroup/programs/blob/5fa810bf16d25cf32c7eca58be084975bec38f96/TGs/verification-task-group/documents/presentations/OpenHWGroup_WorkFlow.pdf) document
is required reading. You will find information about the implementation and usage of the CORE-V verification environments
in the [Verification Strategy](https://docs.openhwgroup.org/projects/core-v-verif/en/latest/index.html).
The [OpenHW Work Flow](https://github.com/openhwgroup/programs/blob/5fa810bf16d25cf32c7eca58be084975bec38f96/TGs/verification-task-group/documents/presentations/OpenHWGroup_WorkFlow.pdf)
document is recommended reading.
## The Mechanics
1. From GitHub: [fork](https://help.github.com/articles/fork-a-repo/) the [cve2](https://github.com/openhwgroup/cve2) repository
@ -13,6 +21,6 @@ in the [Verification Strategy](https://docs.openhwgroup.org/projects/core-v-veri
3. Create your feature branch: `git checkout -b <my_branch>.`<br> Please uniquify your branch name. See the [Git Cheats](https://github.com/openhwgroup/core-v-verif/blob/master/GitCheats.md)
for a useful nominclature.
4. Make your edits...
5. Commit your changes: `git commit -m 'Add some feature' -s`<br>; `-s` or `--sign-off` is engouraged, but not required.
5. Commit your changes: `git commit -m 'Add some feature' -s`
6. Push feature branch: `git push origin <my_branch>`
7. From GitHub: submit a pull request