Skip to content

Commit 9befc95

Browse files
authored
chore: update documentation (#310)
* chore: delete build_spec.yaml * chore: update SECURITY.md * chore: update CONTRIBUTING.md * chore: update README.md * chore: update LICENSE.txt
1 parent 139415d commit 9befc95

File tree

5 files changed

+8
-24
lines changed

5 files changed

+8
-24
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you have any questions about a possible submission, feel free to open an issu
1010

1111
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).
1212

13-
## Pull requests (PRs)
13+
## Contributing code
1414

1515
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:
1616

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2022 Oracle and/or its affiliates.
1+
Copyright (c) 2022, 2023 Oracle and/or its affiliates.
22

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

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Macaron uses [SLSA requirements specifications v0.1](https://slsa.dev/spec/v0.1/
2020

2121
To learn how to download and run Macaron, see our documentation [here](https://oracle-samples.github.io/macaron/).
2222

23-
## How to Contribute
23+
## Contributing
2424

25-
We welcome contributions! See our [contribution guidelines](./CONTRIBUTING.md).
25+
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
2626

2727
## Defining new checks
2828

@@ -34,10 +34,11 @@ To learn how to define your own checks, see the steps in the [checks documentati
3434

3535
We have integrated [SLSA provenance generation](https://github.com/slsa-framework/slsa-github-generator) for our Docker image and release artifacts. However, due to a strict policy regarding the use of third-party GitHub Actions, we cannot generate the provenances in this repository yet until [this issue](https://github.com/slsa-framework/slsa-github-generator/issues/2204) is resolved.
3636

37-
## Security issue reports
37+
## Security
3838

39-
Security issue reports should follow our [reporting guidelines](./SECURITY.md).
39+
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
4040

4141
## License
4242

43+
Copyright (c) 20222, 2023 Oracle and/or its affiliates.
4344
Macaron is licensed under the [Universal Permissive License (UPL), Version 1.0](./LICENSE.txt).

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ security features are welcome on GitHub Issues.
2121

2222
Security updates will be released on a regular cadence. Many of our projects
2323
will typically release security fixes in conjunction with the
24-
[Oracle Critical Patch Update][3] program. Additional
24+
Oracle Critical Patch Update program. Additional
2525
information, including past advisories, is available on our [security alerts][4]
2626
page.
2727

build_spec.yaml

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)