github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-22 05:30:24 +00:00
Code Issues Projects Releases Wiki Activity

doc: Add project CONTRIBUTING repo page

Browse Source 
Summarize the ACRN contributing guidelines (fully documented in a
separate document) and add to the top level of our project repo (as
expected by GitHub and our Technical Steering Committee)

Also, tweak the mailing list reference to recommend acrn-users instead
of acrn-dev

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2021-09-16 15:47:10 -07:00 committed by David Kinder
parent 53fe6d63be
commit 306d624795
2 changed files with 44 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,39 @@
Contribution Guidelines
#######################
As an open-source project, we welcome and encourage the community to submit
patches directly to the project. In our collaborative open-source environment,
standards and methods for submitting changes help reduce the chaos that can result
from an active development community.
This document briefly summarizes the full `Contribution
Guidelines <http://projectacrn.github.io/latest/developer-guides/contribute_guidelines.html>`_
documentation.
* ACRN uses the permissive open source `BSD 3-Clause license`_
that allows you to freely use, modify, distribute and sell your own products
that include such licensed software.
* There are some imported or reused components of the ACRN project that
use other licensing and are clearly identified.
* The Developer Certificate of Origin (DCO) process is followed to
ensure developers are following licensing criteria for their
contributions, and documented with a ``Signed-off-by`` line in commits.
* ACRN development workflow is supported on Linux.
* Source code for the project is maintained in the GitHub repo:
https://github.com/projectacrn/acrn-hypervisor
* Issue and feature tracking is done using GitHub issues in this repo.
* A Continuous Integration (CI) system runs on every Pull Request (PR)
to verify several aspects of the PR including Git commit formatting,
coding style, sanity-check builds, and documentation builds.
* The `ACRN user mailing list`_ is a great place to engage with the
community, ask questions, discuss issues, and help each other.
.. _ACRN user mailing list: https://lists.projectacrn.org/g/acrn-user
.. _BSD 3-Clause license: https://github.com/projectacrn/acrn-hypervisor/blob/master/LICENSE

6
doc/developer-guides/contribute_guidelines.rst
View File

@ -135,6 +135,9 @@ Submitting Issues
.. _ACRN-dev mailing list: .. _ACRN-dev mailing list:
https://lists.projectacrn.org/g/acrn-dev https://lists.projectacrn.org/g/acrn-dev
.. _ACRN-users mailing list:
https://lists.projectacrn.org/g/acrn-users
.. _ACRN hypervisor issues: .. _ACRN hypervisor issues:
https://github.com/projectacrn/acrn-hypervisor/issues https://github.com/projectacrn/acrn-hypervisor/issues
@ -143,7 +146,8 @@ GitHub issues in the `ACRN hypervisor issues`_ list. Before submitting a
bug or enhancement request, first check to see what's already been bug or enhancement request, first check to see what's already been
reported, and add to that discussion if you have additional information. reported, and add to that discussion if you have additional information.
(Be sure to check both the "open" and "closed" issues.) (Be sure to check both the "open" and "closed" issues.)
You should also read through discussions in the `ACRN-dev mailing list`_ You should also read through discussions in the `ACRN-users mailing list`_
(and the `ACRN-dev mailing list`_)
to see what's been reported on or discussed. You may find others that to see what's been reported on or discussed. You may find others that
have encountered the issue you're finding, or that have similar ideas have encountered the issue you're finding, or that have similar ideas
for changes or additions. for changes or additions.