Skip to content
This repository was archived by the owner on Jan 6, 2023. It is now read-only.

Commit 3d5a56a

Browse files
rjeberhardrjeberhard
authored
Merge pull request #21 from oracle/update-template
Update project root files based on latest templates
2 parents aba248a + 0e21b98 commit 3d5a56a

File tree

4 files changed

+89
-48
lines changed

4 files changed

+89
-48
lines changed

‎CONTRIBUTING.md‎

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,55 @@
1-
# Contributing
1+
# Contributing to this repository
22

3-
Oracle welcomes contributions to this repository from anyone.
3+
We welcome your contributions! There are multiple ways to contribute.
44

5-
If you want to submit a pull request to fix a bug or enhance an existing
6-
feature, please first open an issue and link to that issue when you
7-
submit your pull request.
5+
## Opening issues
86

9-
If you have any questions about a possible submission, feel free to open
10-
an issue too.
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).
1112

12-
## Contributing to the WebLogic Logging Exporter repository
13+
## Contributing code
1314

14-
Pull requests can be made under
15-
[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA).
15+
We welcome your code contributions. Before submitting code via a pull request,
16+
you will need to have 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:
1619

17-
For pull requests to be accepted, the bottom of your commit message must have
18-
the following line using your name and e-mail address as it appears in the
19-
OCA Signatories list.
20-
21-
```
20+
```text
2221
Signed-off-by: Your Name <you@example.org>
2322
```
2423

25-
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.
2626

27-
```
28-
git commit --signoff
27+
```text
28+
git commit --signoff
2929
```
3030

31-
Only pull requests from committers that can be verified as having
32-
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.
3333

34-
### Pull request process
34+
## Pull request process
3535

36+
1. Ensure there is an issue created to track and discuss the fix or enhancement
37+
you intend to submit.
3638
1. Fork this repository
3739
1. Create a branch in your fork to implement the changes. We recommend using
38-
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`
3941
1. Ensure that any documentation is updated with the changes that are required
40-
by your fix.
42+
by your change.
4143
1. Ensure that any samples are updated if the base image has been changed.
4244
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
43-
what your changes are meant to do and provide simple steps on how to validate
44-
your changes. Ensure that you reference the issue you created as well.
45-
We will assign the pull request to 2-3 people for review before it is merged.
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.
47+
1. We will assign the pull request to 2-3 people for review before it is merged.
48+
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].
53+
54+
[OCA]: https://oca.opensource.oracle.com
55+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

‎LICENSE.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2018, 2021, 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

@@ -32,4 +32,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
3232
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
3333
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
3434
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35-
SOFTWARE.
35+
SOFTWARE.

‎README.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,11 +186,20 @@ yellow open wls q4Q2v2dXTBOyYsHZMdDe3H 5 1 23
186186
If you wish to test on your local machine, a [sample](samples/run-elk-local.sh) is provided to run Elasticsearch
187187
and Kibana in Docker on your local machine.
188188
189+
189190
## Contributing
190191
191-
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
192+
This project welcomes contributions from the community. Before submitting a pull
193+
request, please [review our contribution guide](./CONTRIBUTING.md).
194+
195+
## Security
192196
197+
Please consult the [security guide](./SECURITY.md) for our responsible security
198+
vulnerability disclosure process.
193199
194200
## License
195201
196-
This project is licensed under the [_Universal Permissive License, Version 1.0_](http://oss.oracle.com/licenses/upl)
202+
Copyright (c) 2017, 2021 Oracle and/or its affiliates.
203+
204+
Released under the Universal Permissive License v1.0 as shown at
205+
<https://oss.oracle.com/licenses/upl/>.

‎SECURITY.md‎

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,40 @@
1-
# Reporting Security Vulnerabilities
2-
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.
4-
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 secalert_us@oracle.com 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.
6-
7-
We ask that you do not use other channels or contact project contributors directly.
8-
9-
Non-vulnerability related security issues such as new great new ideas for security features are welcome on GitHub Issues.
10-
11-
## Security Updates, Alerts and Bulletins
12-
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.
14-
15-
## Security-Related Information
16-
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.
18-
1+
# Reporting security vulnerabilities
2+
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.
6+
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+
[secalert_us@oracle.com][1] preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][2].
11+
We encourage people who contact Oracle Security to use email encryption using
12+
[our encryption key][3].
13+
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
16+
17+
Non-vulnerability related security issues including ideas for new or improved
18+
security features are welcome on GitHub Issues.
19+
20+
## Security updates, alerts and bulletins
21+
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][4]
28+
page.
29+
30+
## Security-related information
31+
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]: mailto:secalert_us@oracle.com
38+
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
39+
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
40+
[4]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)