Commit dde7db23 authored by m5p3nc3r's avatar m5p3nc3r
Browse files

Add more details to the readme

Also tidy up the contribution agreement
parent e7a6e29b
......@@ -2,7 +2,7 @@
The SOAFEE project is open for external contributors and welcomes contributions
licensed under the [MIT license](https://spdx.org/licenses/MIT.html) and all
accepted contributions must have the same license.
accepted contributions must have the same license.
Any documentation contributions are to be made under the [Creative Commons
Attribution 4.0 International License](https://spdx.org/licenses/CC-BY-4.0.html)
......@@ -14,7 +14,7 @@ Before the SOAFEE project accepts your contribution, you need to certify its
origin and give us your permission. To manage this process we use a [Developer
Certificate of Origin (DCO) V1.1](https://developercertificate.org/).
To indicate that you agree to the the terms of the DCO, you "sign off" your
To indicate that you agree to the the terms of the DCO, you "sign off" your
contribution by adding a line with your name and e-mail address to every git
commit message:
......@@ -32,23 +32,10 @@ repository.
## Development repository
The SOAFEE development repository is hosted at https://gitlab.arm.com/soafee by
The SOAFEE development repository is hosted at https://gitlab.arm.com/soafee by
Arm.
## Code reviews
Contributions must go through code review. Code reviews are performed through
the XXXXXX server. Contributors need to signup to this XXXXX server with their
GitHub account credentials.
Only reviewed contributions can go to the master branch of SOAFEE.
## Continuous integration
Contributions to SOAFEE go through testing at the Arm XXX system. All unit,
integration and regression tests must pass before a contribution gets merged to the SOAFEE main branch.
## Communications
We encourage developers who are interested in SOAFEE to subscribe to the SOAFEE
SIG mailing list
We encourage developers who are interested in SOAFEE to communicate through the
gitlab instance provided, or other community agreed mechanisms.
## Introduction
Intro here...
The working groups form the core of the ecosystem engagement of the SOAFEE
project. Working groups are created under the guidance of the Governing Board
with the scope, deliverables and sign-off managed by the board.
Each working group will be covered by the license and contribution agreement
as defined here.
The working practices of the groups are still being defined, but content from
the groups will be captured in the the tickets and wiki of this project.
## License
The software is provided under an [MIT license](https://spdx.org/licenses/MIT.html). Contributions to this project are accepted under the same license.
The software is provided under an [MIT license]
(https://spdx.org/licenses/MIT.html). Contributions to this project are accepted
under the same license.
Documentation is provided under the [Creative Commons Attribution 4.0 International License](https://spdx.org/licenses/CC-BY-4.0.html) and all accepted contributions must have the same license.
Documentation is provided under the [Creative Commons Attribution 4.0
International License](https://spdx.org/licenses/CC-BY-4.0.html) and all
accepted contributions must have the same license.
## Contributions
Details of how to make a contrubutions to the SOAFEE project can be found in the [Contributions](./contributions.md) document.
\ No newline at end of file
Details of how to make a contribution to the SOAFEE project can be found in the
[contributing](./CONTRIBUTING.md) document.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment