-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from oracle/docs-updates
Update docs
- Loading branch information
Showing
1 changed file
with
45 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,55 @@ | ||
# Contributing to the Oracle Cloud Infrastructure PHP SDK | ||
# Contributing to this repository | ||
|
||
*Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. | ||
This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl | ||
or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.* | ||
We welcome your contributions! There are multiple ways to contribute. | ||
|
||
Pull requests can be made under | ||
[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) | ||
(OCA). | ||
## Opening issues | ||
|
||
For pull requests to be accepted, the bottom of | ||
your commit message must have the following line using your name and | ||
e-mail address as it appears in the OCA Signatories list. | ||
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. 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. | ||
|
||
## Pull request process | ||
|
||
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`. | ||
1. Ensure that any documentation is updated with the changes that are required | ||
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 assign the pull request to 2-3 people for review before it is merged. | ||
|
||
## 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]. | ||
|
||
Only pull requests from committers that can be verified as having | ||
signed the OCA can be accepted. | ||
[OCA]: https://oca.opensource.oracle.com | ||
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ |