Skip to content

Commit c9aa2b1

Browse files
authored
Update readme policy (#1)
* update readme policy * Remove directory naming structure from README.md * Replace Contributing with Feedback
1 parent 8b8dcd0 commit c9aa2b1

File tree

2 files changed

+7
-83
lines changed

2 files changed

+7
-83
lines changed

CONTRIBUTING.md

-57
This file was deleted.

README.md

+7-26
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,25 @@
1-
*This repository acts as a template for all of Oracle’s GitHub repositories. It contains information about the guidelines for those repositories. All files and sections contained in this template are mandatory, and a GitHub app ensures alignment with these guidelines. To get started with a new repository, replace the italic paragraphs with the respective text for your project.*
1+
# Samples
22

3-
# Project name
4-
5-
*Describe your project's features, functionality and target audience*
3+
This repository contains sample code in order for developers to reproduce complex examples shared on https://inside.java or https://dev.java.
64

75
## Installation
86

9-
*Provide detailed step-by-step installation instructions. You can name this section **How to Run** or **Getting Started** instead of **Installation** if that's more acceptable for your project*
10-
11-
## Documentation
12-
13-
*Developer-oriented documentation can be published on GitHub, but all product documentation must be published on <https://docs.oracle.com>*
14-
15-
## Examples
16-
17-
*Describe any included examples or provide a link to a demo/tutorial*
7+
Each sample directory contains its own instructions (SETUP.md) on how to run the example(s).
188

19-
## Help
9+
## Content
2010

21-
*Inform users on where to get help or how to receive official support from Oracle (if applicable)*
11+
<!--- Contains a list of directories and link to published article -->
2212

23-
## Contributing
13+
## Feedback
2414

25-
*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained*
26-
27-
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
15+
If you spot an error, or you know of an alternative way/an extra question/solution that you can offer, please raise an issue on https://github.com/java/devrel.
2816

2917
## Security
3018

3119
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
3220

3321
## License
3422

35-
*The correct copyright notice format for both documentation and software is*
36-
"Copyright (c) [year,] year Oracle and/or its affiliates."
37-
*You must include the year the content was first released (on any platform) and the most recent year in which it was revised*
38-
3923
Copyright (c) 2023 Oracle and/or its affiliates.
40-
41-
*Replace this statement if your project is not licensed under the UPL*
42-
4324
Released under the Universal Permissive License v1.0 as shown at
4425
<https://oss.oracle.com/licenses/upl/>.

0 commit comments

Comments
 (0)