Skip to content

Commit eeecad7

Browse files
committed
documentation alignment
1 parent 399ab0b commit eeecad7

File tree

4 files changed

+69
-8
lines changed

4 files changed

+69
-8
lines changed

CONTRIBUTING.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# Contributing to VisualVM
22

3-
*Copyright © 2017, 2020, Oracle Corporation and/or its affiliates.*
3+
## Opening issues
4+
5+
Please let us know your ideas, missing features, or bugs found. Either [file a RFE/bug](https://github.com/oracle/visualvm/issues/new/choose) or [leave us a message](https://visualvm.github.io/feedback.html).
6+
7+
Any information, ideas or suggestions that you provide to us either through a Bug Report or a Feature Request ([https://github.com/oracle/visualvm/issues/new/choose](https://github.com/oracle/visualvm/issues/new/choose)) or using Gitter chat or email shall be considered Feedback. If you think you've found a security
8+
vulnerability, do not raise a GitHub issue and follow the instructions in our [security policy](./SECURITY.md).
9+
10+
## Contributing code
11+
12+
For legal reasons, we cannot accept external pull requests.
13+
14+
## Pull request process
415

516
**Pull requests are currently not being accepted for the VisualVM project.**
617

7-
Please let us know your ideas, missing features, or bugs found. Either [file a RFE/bug](https://github.com/oracle/visualvm/issues/new/choose) or [leave us a message](https://visualvm.github.io/feedback.html).
18+
## Code of conduct
819

9-
Any information, ideas or suggestions that you provide to us either through a Bug Report or a Feature Request ([https://github.com/oracle/visualvm/issues/new/choose](https://github.com/oracle/visualvm/issues/new/choose)) or using Gitter chat or email shall be considered Feedback.
20+
Oracle and its affiliates have a perpetual, royalty-free, non-exclusive, irrevocable license to use, reproduce, distribute or otherwise commercialize any Feedback that you voluntarily provide. Oracle shall have no obligation to respond to any Feedback or to incorporate your Feedback into the VisualVM software.
1021

11-
Oracle and its affiliates have a perpetual, royalty-free, non-exclusive, irrevocable license to use, reproduce, distribute or otherwise commercialize any Feedback that you voluntarily provide. Oracle shall have no obligation to respond to any Feedback or to incorporate your Feedback into the VisualVM software.

LICENSE renamed to LICENSE.txt

File renamed without changes.

README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,29 @@ First download or clone this repository into directory `visualvm`. There are two
1616

1717
Then download and extract the [NetBeans Platform 14](https://github.com/oracle/visualvm/releases/download/2.1.5/nb140_platform_20220908.zip) into directory `visualvm/visualvm` (should create `visualvm/visualvm/netbeans`).
1818

19-
## Build and run VisualVM tool
19+
## How to build
2020

21-
To build VisualVM, use `ant build-zip` command in the `visualvm/visualvm` directory. To run VisualVM, use `ant run` command in the `visualvm/visualvm` directory.
21+
To build VisualVM, use `ant build-zip` command in the `visualvm/visualvm` directory.
2222

23-
## Build and run VisualVM plugins
23+
## How to run
24+
25+
To run VisualVM, use `ant run` command in the `visualvm/visualvm` directory.
26+
27+
## Build and run plugins
2428

2529
To build or run the plugins suite, use `ant build` or `ant run` in the `visualvm/plugins` directory. This will automatically build the zip distribution of the core VisualVM tool into `visualvm/visualvm/dist/visualvm.zip` and extract it into the `visualvm/plugins/visualvm` directory. After that the build of the plugins suite continues to build each of the individual plugins. Running the plugins suite means starting VisualVM with all the plugins installed.
2630

27-
## Contribute
31+
## Contributing
2832

2933
We highly appreciate any feedback! Please let us know your ideas, missing features, or bugs found. Either [file a RFE/bug](https://github.com/oracle/visualvm/issues/new/choose) or [leave us a message](https://visualvm.github.io/feedback.html). For legal reasons, we cannot accept external pull requests. See
3034
[CONTRIBUTING](https://github.com/oracle/visualvm/blob/master/CONTRIBUTING.md)
3135
for details.
36+
37+
## Security
38+
39+
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
40+
41+
## License
42+
43+
Copyright (c) 2017, 2023 Oracle and/or its affiliates.
44+
Released under the GNU General Public License, version 2, with the Classpath Exception.

SECURITY.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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+
[[email protected]][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 program. Additional
25+
information, including past advisories, is available on our [security alerts][4]
26+
page.
27+
28+
## Security-related information
29+
30+
We will provide security related information such as a threat model, considerations
31+
for secure use, or any known security issues in our documentation. Please note
32+
that labs and sample code are intended to demonstrate a concept and may not be
33+
sufficiently hardened for production use.
34+
35+
[1]: mailto:[email protected]
36+
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
37+
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
38+
[4]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)