eclipse-sailing-analytics/sailing-analytics
1
0
Fork 0
mirror of https://github.com/eclipse-sailing-analytics/sailing-analytics.git synced 2026-09-18 11:49:09 +00:00
Code Activity

Adjust README content

Browse Source
This commit is contained in:
SAP OSPO
2024-04-22 16:09:56 +00:00
parent 5e01934ff4
commit 1faac7f86e
1 changed files with 6 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -20
View File
@@ -1,24 +1,10 @@
# SAP Repository Template
[![REUSE status](https://api.reuse.software/badge/github.com/SAP/sailing-analytics)](https://api.reuse.software/info/github.com/SAP/sailing-analytics)
Default templates for SAP open source repositories, including LICENSE, .reuse/dep5, Code of Conduct, etc... All repositories on github.com/SAP will be created based on this template.
## To-Do
In case you are the maintainer of a new SAP open source project, these are the steps to do with the template files:
- Check if the default license (Apache 2.0) also applies to your project. A license change should only be required in exceptional cases. If this is the case, please change the [license file](LICENSE).
- Enter the correct metadata for the REUSE tool. See our [wiki page](https://wiki.one.int.sap/wiki/display/ospodocs/Using+the+Reuse+Tool+of+FSFE+for+Copyright+and+License+Information) for details how to do it. You can find an initial .reuse/dep5 file to build on. Please replace the parts inside the single angle quotation marks < > by the specific information for your repository and be sure to run the REUSE tool to validate that the metadata is correct.
- Adjust the contribution guidelines (e.g. add coding style guidelines, pull request checklists, different license if needed etc.)
- Add information about your project to this README (name, description, requirements etc). Especially take care for the <your-project> placeholders - those ones need to be replaced with your project name. See the sections below the horizontal line and [our guidelines on our wiki page](https://wiki.one.int.sap/wiki/pages/viewpage.action?pageId=3564976048#GuidelinesforGitHubHealthfiles(Readme,Contributing,CodeofConduct)-Readme.md) what is required and recommended.
- Remove all content in this README above and including the horizontal line ;)
***
# Our new open source project
# Sailing Analytics
## About this project
*Insert a short description of your project here...*
The Sailing Analytics, formerly known as the "SAP Sailing Analytics," are a solution for portraying and analyzing sailing regattas, support training scenarios, and power the vast archive at https://sapsailing.com.
## Requirements and Setup
@@ -26,10 +12,10 @@ In case you are the maintainer of a new SAP open source project, these are the s
## Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/<your-project>/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/sailing-analytics/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
## Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/<your-project>/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/sailing-analytics/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
## Code of Conduct
@@ -37,4 +23,4 @@ We as members, contributors, and leaders pledge to make participation in our com
## Licensing
Copyright (20xx-)20xx SAP SE or an SAP affiliate company and <your-project> contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/<your-project>).
Copyright 2024 SAP SE or an SAP affiliate company and sailing-analytics contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/sailing-analytics).