Skip to content

Commit

Permalink
[DOC] Prepare for OSS Release
Browse files Browse the repository at this point in the history
- Adjust README
- Add CONTRIBUTING file
  • Loading branch information
FelixSchladt committed Sep 17, 2024
1 parent 2b1535b commit 7e811f7
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 9 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## How to contribute to TRENTOS

#### **Did you find a bug?**

* **Do not open up a GitHub issue if the bug is a security vulnerability
in TRENTOS**, and instead send an email to [[email protected]](mailto:[email protected]?subject=TRENTOS:%20Security%20Vulnerability).

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/TRENT-OS/trentos/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/TRENT-OS/trentos/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.


#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.

* If the bug is in one of the submodules, please open a pull request in all modules up to the TRENTOS root repository. The root repository is the central place for all pull requests.


#### **Do you intend to add a new feature or change an existing one?**

* Please open an issue in advance and get some feedback and advice on the proposed feature. If you already have code to contribute, feel free to open a pull request.

* Any pull request in one of the submodules must be accompanied by pull requests moving the feature commit into the root repository.


#### **Do you have questions about the source code?**

* Feel free to open an issue and describing your question.


#### **Do you want to contribute to the TRENTOS documentation?**

* Open an issue and tag it with the `documentation` label. Describe you intended changes and or open a pull request with your changes and link it.


Thanks! :heart: :heart: :heart:

TRENTOS Team
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,8 @@ Even more demos are available as [submodules](https://github.com/orgs/TRENT-OS/r
## Contributing

Contributions are always welcome.
To get started please read our [CONTRIBUTING.md](./CONTRIBUTING.md).

TODO: Add contributing

If you have any questions or encounter any bugs, please do not hesitate to open an **issue**.
To get started please read our [CONTRIBUTING.md](./CONTRIBUTING.md).


## Docker Images
Expand All @@ -116,11 +113,10 @@ Dockerfiles are hosted in [Docker Images](https://github.com/TRENT-OS/docker_ima

TRENTOS is available under the OSS GPLv2-or-later license.
Upon request commercial licensing options are available.
Please contact: [[email protected]](mailto:[email protected]?subject=TRENTOS:%20Commercial%20Licensing)
for more information.
Please contact: [[email protected]](mailto:[email protected]?subject=TRENTOS:%20Commercial%20Licensing) for more information.

Some few components are only available und different licensing terms.
Due to the microkernel concept this should not be an issue as long as these are used as a TRENTOS component.
A select few components are only available under different licensing terms.
Due to the microkernel concept this may not be an issue as long as these are used as a distinct TRENTOS component.

TODO: Link documentation explaining the seL4 component concept.

Expand All @@ -133,7 +129,7 @@ TODO: Link wiki page explaining the test framework

## Dependencies

TRENTOS builds upon varies open source libraries:
TRENTOS builds upon varies open source libraries and projects:

* sel4
* muslc
Expand Down

0 comments on commit 7e811f7

Please sign in to comment.