|
1 |
| -# cap-js Repository Template |
| 1 | +# alert-notification |
2 | 2 |
|
3 |
| -Default templates for cap-js open source repositories, including LICENSE, .reuse/dep5, Code of Conduct, etc... All repositories on github.com/cap-js will be created based on this template. |
4 |
| - |
5 |
| -## To-Do |
6 |
| - |
7 |
| -In case you are the maintainer of a new cap-js open source project, these are the steps to do with the template files: |
8 |
| - |
9 |
| -- 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). |
10 |
| -- Enter the correct metadata for the REUSE tool. See our [wiki page](https://wiki.wdf.sap.corp/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. |
11 |
| -- Adjust the contribution guidelines (e.g. add coding style guidelines, pull request checklists, different license if needed etc.) |
12 |
| -- 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.wdf.sap.corp/wiki/display/ospodocs/Guidelines+for+README.md+file) what is required and recommended. |
13 |
| -- Remove all content in this README above and including the horizontal line ;) |
14 |
| - |
15 |
| -*** |
16 |
| - |
17 |
| -# Our new open source project |
18 |
| - |
19 |
| -## About this project |
20 |
| - |
21 |
| -*Insert a short description of your project here...* |
22 |
| - |
23 |
| -## Requirements and Setup |
24 |
| - |
25 |
| -*Insert a short description what is required to get your project running...* |
26 |
| - |
27 |
| -## Support, Feedback, Contributing |
28 |
| - |
29 |
| -This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/<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). |
30 |
| - |
31 |
| -## Code of Conduct |
32 |
| - |
33 |
| -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times. |
34 |
| - |
35 |
| -## Licensing |
36 |
| - |
37 |
| -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/cap-js/<your-project>). |
0 commit comments