Skip to content

Commit 7dd49c4

Browse files
authored
Merge pull request openhwgroup#278 from MikeOpenHWGroup/quicktest
Quicktest: add info for new contributors
2 parents c8d305b + e410475 commit 7dd49c4

File tree

2 files changed

+31
-6
lines changed

2 files changed

+31
-6
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
New Contributors are always welcome!
3+
4+
## Contributor Agreement
5+
Most Contributors are [members](https://www.openhwgroup.org/membership/) of the
6+
OpenHW Group and participate in one or more [Technical Task Groups](https://www.openhwgroup.org/working-groups/).
7+
Membership is strongly encouraged, but not required.
8+
Contributors must be covered by the terms of the [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php)
9+
(for individuals) **or** the [Eclipse Member Committer and Contributor Agreement](https://www.eclipse.org/legal/committer_process/EclipseMemberCommitterAgreement.pdf)
10+
(for employees of Member companies).
11+
The ECA/MCCA provides a legal framework for a Contributor's technical contributions to the OpenHW Group,
12+
including provisions for grant of copyright license and a Developer
13+
Certificate of Origin on contributions merged into OpenHW Group repositories.
14+
15+
## The Mechanics
16+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the [core-v-mcu](https://github.com/openhwgroup/core-v-mcu) repository
17+
2. Clone repository: `git clone https://github.com/[your_github_username]/core-v-mcu`
18+
3. Checkout the correct branch reflecting the nature of your contribution.
19+
4. 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.
20+
5. Commit your changes: `git commit -m 'Add some feature'
21+
6. Push feature branch: `git push origin <my_branch>`
22+
7. Submit a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
23+
8. If known, it is advisable to select one or more appropriate reviewers for your PR.

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33

44
# CORE-V MCU
55

6-
> CORE-V MCU originated from PULPissimo \[[1](https://ieeexplore.ieee.org/abstract/document/8640145)\], \[[2](https://ieeexplore.ieee.org/document/9369856)\]. and is now a
7-
> stand-alone project within OpenHW Group independent from PULPIssimo.
8-
>
9-
> In case you should be interested to join the project please feel free to open
10-
> an issue, or involve yourself in any open issues/discussions.
6+
CORE-V MCU originated from PULPissimo \[[1](https://ieeexplore.ieee.org/abstract/document/8640145)\], \[[2](https://ieeexplore.ieee.org/document/9369856)\],
7+
and is now a stand-alone project within OpenHW Group independent from PULPIssimo.
8+
9+
In case you would be interested to join the project please feel free to open an issue, or involve yourself in any open issues/discussions.
10+
Contributions are always welcome!
11+
First time contributors should review the [Contributing](https://github.com/openhwgroup/core-v-mcu/tree/master/CONTRIBUTING.md) guide.
1112

1213
## Quick Start Guide
1314

@@ -128,7 +129,8 @@ fusesoc --cores-root . run --target=sim --setup --build --run openhwgroup.org:sy
128129

129130
## Contributing: Pre-commit checks
130131

131-
If you are submitting a pull-request, it will be subject to pre-commit checks. The two that most likely cause problems are the Verilator Lint check and the Verible format check.
132+
If you are submitting a pull-request, it will be subject to pre-commit checks.
133+
The two that most likely cause problems are the Verilator Lint check and the Verible format check.
132134

133135
### Verilator model library
134136

0 commit comments

Comments
 (0)