dnrops
/
python-oracledb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Address PR #145 and some additional line wrapping.

This commit is contained in:
Anthony Tuininga 2023-02-14 10:48:53 -07:00
parent b44e22fd55
commit dea2f25a35
3 changed files with 41 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
CONTRIBUTING.md
View File

@ -1,51 +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).
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
To get started, you will need to sign the [Oracle Contributor
Agreement](https://oca.opensource.oracle.com) (OCA).
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 <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
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
## 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
your changes. Ensure that you reference the issue you created as well.
1. We will review your PR before it is merged.
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.
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.
## 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](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
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/

11
README.md
View File

@ -66,11 +66,18 @@ See [/tests][tests]
## Contributing
See [CONTRIBUTING](https://github.com/oracle/python-oracledb/blob/main/CONTRIBUTING.md)
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
See [LICENSE][license], [THIRD_PARTY_LICENSES][tplicense], and [NOTICE][notice].
See [LICENSE][license], [THIRD_PARTY_LICENSES][tplicense], and
[NOTICE][notice].
[python]: https://www.python.org/
[oracledb]: https://www.oracle.com/database/

0
.github/SECURITY.md → SECURITY.md
View File