Merge pull request #72 from oracle/docs-updates

Update README.md and SECURITY.md

Author: aosingh

CONTRIBUTING.md

@@ -2,27 +2,34 @@
 
 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.
+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
 
-We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement (OCA)](https://oca.opensource.oracle.com/).
-
-For pull requests to be accepted, the bottom of your commit message must have the following line using the name and e-mail address you used for the 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
+your commits need to include the following line using the name and e-mail
+address you used to sign the OCA:
 
 ```text
 Signed-off-by: Your Name <[email protected]>
 ```
 
-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 signed the OCA can be accepted.
+Only pull requests from committers that can be verified as having signed the OCA
+can be accepted.
 
 ## Pull request process
 
@@ -224,7 +231,10 @@ Run the upload command to upload all archives in dist/*
 python3 -m twine upload dist/*
 ```
 
+## 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].
 
-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/)
+[OCA]: https://oca.opensource.oracle.com
+[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

README.md

@@ -17,13 +17,17 @@ For installation, read how you can set up [Oracle profile][1] for dbt
 
 To get started, a sample dbt project can be found in the directory [/dbt_adbs_test_project][5]
 
-## Contributing <a name='contributing'></a>
-This project welcomes contributions from the community. Before submitting a pull request, please review our [contribution guide][2].
+## Contributing
 
-## Security <a name='security'></a>
-Please consult the [security guide][3] for our responsible security vulnerability disclosure process.
+*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained*
 
-## License <a name='license'></a>
+This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
+
+## Security
+
+Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
+
+## License
 dbt-oracle is licensed under Apache 2.0 License which you can find [here][4]
 
 [1]: https://docs.getdbt.com/reference/warehouse-profiles/oracle-profile