Skip to content

Commit 2edd860

Browse files
committed
[docs] Update the content and formatting of all template files
Formatting has been improved to adhere to Markdown standards by using `markdownlint` as the verification tool. Content has been updated to provide additional information for maintainers. Signed-off-by: Avi Miller <[email protected]>
1 parent c999abd commit 2edd860

File tree

4 files changed

+95
-36
lines changed

4 files changed

+95
-36
lines changed

CONTRIBUTING.md

+29-18
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,55 @@
1-
# Contributing
1+
# Contributing to this repository
22

33
We welcome your contributions! There are multiple ways to contribute.
44

5-
## Issues
5+
## Opening issues
66

7-
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 on our [Security Policy](./SECURITY.md).
7+
For bugs or enhancement requests, please file a GitHub issue unless it's
8+
security related. When filing a bug remember that the better written the bug is,
9+
the more likely it is to be fixed. If you think you've found a security
10+
vulnerability, do not raise a GitHub issue and follow the instructions in our
11+
[security policy](./SECURITY.md).
812

9-
## Contributing Code
13+
## Contributing code
1014

11-
We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA).
12-
13-
For pull requests to be accepted, the bottom of your commit message must have
14-
the following line using the name and e-mail address you used for the OCA.
15+
We welcome your code contributions. Before submitting code via a pull request,
16+
you will need to haved signed the [Oracle Contributor Agreement][OCA] (OCA) and
17+
your commits need to include the following line using the name and e-mail
18+
address you used to sign the OCA:
1519

1620
```text
1721
Signed-off-by: Your Name <[email protected]>
1822
```
1923

20-
This can be automatically added to pull requests by committing with:
24+
This can be automatically added to pull requests by committing with `--sign-off`
25+
or `-s`, e.g.
2126

2227
```text
2328
git commit --signoff
2429
```
2530

26-
Only pull requests from committers that can be verified as having
27-
signed the OCA can be accepted.
31+
Only pull requests from committers that can be verified as having signed the OCA
32+
can be accepted.
2833

29-
### Pull request process
34+
## Pull request process
3035

36+
1. Ensure there is an issue created to track and discuss the fix or enhancement
37+
you intend to submit.
3138
1. Fork this repository
3239
1. Create a branch in your fork to implement the changes. We recommend using
33-
the issue number as part of your branch name, e.g. `1234-fixes`
40+
the issue number as part of your branch name, e.g. `1234-fixes`
3441
1. Ensure that any documentation is updated with the changes that are required
35-
by your fix.
42+
by your change.
3643
1. Ensure that any samples are updated if the base image has been changed.
3744
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
38-
what your changes are meant to do and provide simple steps on how to validate
39-
your changes. Ensure that you reference the issue you created as well.
45+
what your changes are meant to do and provide simple steps on how to validate
46+
your changes. Ensure that you reference the issue you created as well.
4047
1. We will assign the pull request to 2-3 people for review before it is merged.
4148

42-
## Code of Conduct
49+
## Code of conduct
50+
51+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
52+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
4353

44-
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](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
54+
[OCA]: https://www.oracle.com/technetwork/community/oca-486395.html
55+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

LICENSE.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2020 Oracle and/or its affiliates.
1+
Copyright (c) 2021 Oracle and/or its affiliates.
22

33
The Universal Permissive License (UPL), Version 1.0
44

README.md

+34-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,46 @@
1-
# About [PROJECT NAME]
2-
&lt;Describe your project and who it is for&gt;
1+
# About [project]
2+
3+
> Describe your project's features, functionality and target audience
34
45
## Installation
5-
&lt;Installation instructions go here&gt;
6+
7+
> Provide detailed step-by-step installation instructions
68
79
## Documentation
8-
&lt;Links to documentation go here&gt;
10+
11+
> Developer-oriented documentation can be published on GitHub, but all product
12+
documentation must be published on <https://docs.oracle.com>.
913
1014
## Examples
11-
&lt;Describe where to find examples&gt;
15+
16+
> Describe any included examples or provide a link to a demo/tutorial
1217
1318
## Help
14-
&lt;Instructions on where to get help go here&gt;
19+
20+
> Inform users on where to get help or how to receive official support from Oracle
21+
(if applicable).
1522

1623
## Contributing
17-
See [CONTRIBUTING](./CONTRIBUTING.md) for details.
24+
25+
> If your project has specific contribution requirements, update the
26+
`CONTRIBUTING.md` file to ensure those requirements are clearly explained.
27+
28+
This project welcomes contributions from the community. Before submitting a pull
29+
request, please [review our contribution guide](./CONTRIBUTING.md).
1830

1931
## Security
20-
See [SECURITY](./SECURITY.md) for details.
32+
33+
Please consult the [security guide](./SECURITY.md) for our responsible security
34+
vulnerability disclosure process.
35+
36+
## License
37+
38+
> The correct copyright notice format for both documentation and software
39+
is `Copyright (c) [year,] year Oracle and/or its affiliates.`
40+
You must include the year the content was first released (on any platform) and
41+
the most recent year in which it was revised.
42+
43+
Copyright (c) 2021 Oracle and/or its affiliates.
44+
45+
Released under the Universal Permissive License v1.0 as shown at
46+
<https://oss.oracle.com/licenses/upl/>.

SECURITY.md

+31-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,39 @@
1-
# Reporting Security Vulnerabilities
1+
# Reporting security vulnerabilities
22

3-
Oracle values the independent security research community and believes that responsible disclosure of security vulnerabilities helps us ensure the security and privacy of all our users.
3+
Oracle values the independent security research community and believes that
4+
responsible disclosure of security vulnerabilities helps us ensure the security
5+
and privacy of all our users.
46

5-
Please do NOT raise a GitHub Issue to report a security vulnerability. If you believe you have found a security vulnerability, please submit a report to [email protected] preferably with a proof of concept. We provide additional information on [how to report security vulnerabilities to Oracle](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html) which includes public encryption keys for secure email.
7+
Please do NOT raise a GitHub Issue to report a security vulnerability. If you
8+
believe you have found a security vulnerability, please submit a report to
9+
<mailto:[email protected]> preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][1].
11+
We encourage people who contact Oracle Security to use email encryption using
12+
[our encryption key][2].
613

7-
We ask that you do not use other channels or contact project contributors directly.
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
816

9-
Non-vulnerability related security issues such as great new ideas for security features are welcome on GitHub Issues.
17+
Non-vulnerability related security issues including ideas for new or improved
18+
security features are welcome on GitHub Issues.
1019

11-
## Security Updates, Alerts and Bulletins
20+
## Security updates, alerts and bulletins
1221

13-
Security updates will be released on a regular cadence. Many of our projects will typically release security fixes in conjunction with the [Oracle Critical Patch Update](https://www.oracle.com/security-alerts/) program. Security updates are released on the Tuesday closest to the 17th day of January, April, July and October. A pre-release announcement will be published on the Thursday preceding each release. Additional information, including past advisories, is available on our [Security Alerts](https://www.oracle.com/security-alerts/) page.
22+
Security updates will be released on a regular cadence. Many of our projects
23+
will typically release security fixes in conjunction with the
24+
[Oracle Critical Patch Update][3] program. Security updates are released on the
25+
Tuesday closest to the 17th day of January, April, July and October. A pre-release
26+
announcement will be published on the Thursday preceding each release. Additional
27+
information, including past advisories, is available on our [security alerts][3]
28+
page.
1429

15-
## Security-Related Information
30+
## Security-related information
1631

17-
We will provide security related information such as a threat model, considerations for secure use, or any known security issues in our documentation. Please note that labs and sample code are intended to demonstrate a concept and may not be sufficiently hardened for production use.
32+
We will provide security related information such as a threat model, considerations
33+
for secure use, or any known security issues in our documentation. Please note
34+
that labs and sample code are intended to demonstrate a concept and may not be
35+
sufficiently hardened for production use.
36+
37+
[1]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
38+
[2]: https://www.oracle.com/security-alerts/encryptionkey.html
39+
[3]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)