diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 85ab22a..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,57 +0,0 @@ -*Detailed instructions on how to contribute to the project, if applicable. Must include section about Oracle Contributor Agreement with link and instructions* - -# Contributing to this repository - -We welcome your contributions! There are multiple ways to contribute. - -## Opening issues - -For bugs or enhancement requests, please file a GitHub issue unless it's -security related. When filing a bug remember that the better written the bug is, -the more likely it is to be fixed. If you think you've found a security -vulnerability, do not raise a GitHub issue and follow the instructions in our -[security policy](./SECURITY.md). - -## Contributing code - -We welcome your code contributions. Before submitting code via a pull request, -you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and -your commits need to include the following line using the name and e-mail -address you used to sign the OCA: - -```text -Signed-off-by: Your Name -``` - -This can be automatically added to pull requests by committing with `--sign-off` -or `-s`, e.g. - -```text -git commit --signoff -``` - -Only pull requests from committers that can be verified as having signed the OCA -can be accepted. - -## Pull request process - -1. Ensure there is an issue created to track and discuss the fix or enhancement - you intend to submit. -1. Fork this repository. -1. Create a branch in your fork to implement the changes. We recommend using - the issue number as part of your branch name, e.g. `1234-fixes`. -1. Ensure that any documentation is updated with the changes that are required - by your change. -1. Ensure that any samples are updated if the base image has been changed. -1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly - what your changes are meant to do and provide simple steps on how to validate. - your changes. Ensure that you reference the issue you created as well. -1. We will assign the pull request to 2-3 people for review before it is merged. - -## Code of conduct - -Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd -like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC]. - -[OCA]: https://oca.opensource.oracle.com -[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ diff --git a/README.md b/README.md index fe93493..2a184b4 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,18 @@ -*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.* +# Samples -# Project name - -*Describe your project's features, functionality and target audience* +This repository contains sample code in order for developers to reproduce complex examples shared on https://inside.java or https://dev.java. ## Installation -*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* - -## Documentation - -*Developer-oriented documentation can be published on GitHub, but all product documentation must be published on * - -## Examples - -*Describe any included examples or provide a link to a demo/tutorial* +Each sample directory contains its own instructions (SETUP.md) on how to run the example(s). -## Help +## Content -*Inform users on where to get help or how to receive official support from Oracle (if applicable)* + -## Contributing +## Feedback -*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained* - -This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md) +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. ## Security @@ -32,13 +20,6 @@ Please consult the [security guide](./SECURITY.md) for our responsible security ## License -*The correct copyright notice format for both documentation and software is* - "Copyright (c) [year,] year Oracle and/or its affiliates." -*You must include the year the content was first released (on any platform) and the most recent year in which it was revised* - Copyright (c) 2023 Oracle and/or its affiliates. - -*Replace this statement if your project is not licensed under the UPL* - Released under the Universal Permissive License v1.0 as shown at .