PR#1543 with some fixes and node-oracledb specific

CONTRIBUTING.md

@@ -1,44 +1,58 @@
-# Contributing
+# Contributing to this repository
 
 We welcome your contributions! There are multiple ways to contribute.
 
-## Issues
+## 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 on our [Security Policy](./.github/SECURITY.md).
+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
+## Contributing code
 
-We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement](https://oca.opensource.oracle.com) (OCA).
+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
-For pull requests to be accepted, the bottom of your commit message must have
+your commits need to include the following line using the name and e-mail
-the following line using the name and e-mail address you used for the OCA.
+address you used to sign the OCA:
 
 ```text
 Signed-off-by: Your Name <you@example.org>
 ```
 
-This can be automatically added to pull requests by committing with:
+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
+Only pull requests from committers that can be verified as having signed the OCA
-signed the OCA can be accepted.
+can be accepted.
 
-### Pull request process
+## Pull request process
 
-1. Fork this repository
+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`
+   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 fix.
+   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
+   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.
+   your changes. Ensure that you reference the issue you created as well.
-1. We will review your PR before it is merged.
+1. We will assign the pull request to 2-3 people for review before it is merged.
 
-## Code of Conduct
+Note we merge to an internal repo first before pushing back to GitHub.
 
-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/)
+## 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/

README.md

@@ -16,19 +16,19 @@ and Oracle Client.  See the [homepage][4] for a list.
 The node-oracledb module is open source and maintained by Oracle Corp.
 It is stable, well documented, and has a comprehensive test suite.
 
-## <a name="installation"></a> Installation
+## Installation
 
 See [Getting Started with Node-oracledb][1] and [Quick Start Node-oracledb Installation][2].
 
-## <a name="doc"></a> Documentation
+## Documentation
 
 See [Documentation for the Oracle Database Node.js Add-on][32] and the [CHANGELOG][33].
 
-## <a name="examples"></a> Examples
+## Examples
 
 See the [examples][30] directory.  Start with [examples/example.js][31].
 
-## <a name="help"></a> Help
+## Help
 
 Issues and questions about node-oracledb can be posted on [GitHub][3] or
 [Slack][5] ([link to join Slack][6]).
@@ -37,15 +37,20 @@ Issues and questions about node-oracledb can be posted on [GitHub][3] or
 
 To run the test suite see [test/README][34].
 
-## <a name="contrib"></a> Contributing
+## Contributing
 
-Node-oracledb is an open source project. See [CONTRIBUTING][35] for
+This project welcomes contributions from the community. Before submitting a
-details.
+pull request, please [review our contribution guide](./CONTRIBUTING.md).
 
-Oracle gratefully acknowledges the contributions to node-oracledb that
+Oracle gratefully acknowledges the contributions to node-oracledb that have
-have been made by the community.
+been made by the community.
 
-## <a name="license"></a> License
+## Security
+
+Please consult the [security guide](./SECURITY.md) for our responsible security
+vulnerability disclosure process.
+
+## License
 
 Copyright (c) 2015, 2023, Oracle and/or its affiliates.