Skip to content

Latest commit

 

History

History
44 lines (23 loc) · 1.96 KB

README.md

File metadata and controls

44 lines (23 loc) · 1.96 KB
Raw

Thales Open Source Template Project

Template for creating a new project in the Thales GitHub organization.

Each Thales OSS project repository MUST contain the following files at the root:

  • a LICENSE which has been chosen in accordance with legal department depending on your needs

  • a README.md outlining the project goals, sponsoring sig, and community contact information, GitHub tips about README.md

  • a CONTRIBUTING.md outlining how to contribute to the project, how to submit a pull request and an issue

  • a SECURITY.md outlining how the security concerns are handled, GitHub tips about SECURITY.md

Below is an example of the common structure and information expected in a README.

Please keep this structure as is and only fill the content for each section according to your project.

If you need assistance or have question, please contact [email protected]

Get started

XXX project purpose it to ...

Please also add the description into the About section (Description field)

Documentation

Documentation is available at xxx/docs.

You can use GitHub pages to create your documentation.

See an example here : https://github.com/ThalesGroup/ThalesGroup.github.io

Please also add the documentation URL into the About section (Website field)

Contributing

If you are interested in contributing to the XXX project, start by reading the Contributing guide.

License

The chosen license in accordance with legal department must be defined into an explicit LICENSE file at the root of the repository You can also link this file in this README section.