Skip to content

Commit 850b0ae

Browse files
authored
Create contributing guide document. (#38)
* Create contributing guide document. * Bump copyright to 2021 in README * update changelog and contributing guide Signed-off-by: Alexey Dolganov <[email protected]>
1 parent 4c2b22e commit 850b0ae

File tree

3 files changed

+66
-2
lines changed

3 files changed

+66
-2
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,32 @@
1+
## 2.0.2 - 2021-01-22
2+
3+
### Added
4+
5+
* CONTRIBUTING.md - contributor's guide
6+
7+
### Changed
8+
9+
* Add link to CONTRIBUTING.md in README.md
10+
* Bump copyright year to 2021 in README.md
11+
12+
13+
## 2.0.1 - 2019-05-08
14+
15+
### Changed
16+
17+
* v0.12 preparation: Fix metadata usage to be canonical
18+
19+
120
## 2.0.0 - 2018-12-04
221

322
### Changed
23+
424
- Updated Hostname label for multiple compute instances
525
- Updated Volume display name
626
- Changes variable assign_public_ip default from true to false
727

828
### Added
29+
930
* Support for multiple subnets
1031
* Support for paravirtualized attachments
1132
* Support for private IP list

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# CONTRIBUTING
2+
3+
Oracle welcomes contributions to this repository from anyone.
4+
5+
If you want to submit a pull request to fix a bug or enhance an existing feature, please first open an issue and link to that issue when you submit your pull request.
6+
7+
If you have any questions about a possible submission, feel free to open an issue too.
8+
9+
## Contributing to the terraform-oci-compute-instance repository
10+
11+
Pull requests can be made under The Oracle Contributor Agreement(OCA).
12+
13+
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.
14+
15+
`Signed-off-by: Your Name <[email protected]>`
16+
17+
This can be automatically added to pull requests by committing with:
18+
19+
`git commit --signoff`
20+
21+
or by turning on the "Always Sign Off" flag in your IDE's preferences.
22+
23+
Only pull requests from committers that can be verified as having signed the OCA can be accepted.
24+
25+
## Pull request process
26+
27+
1. Fork this repository
28+
29+
1. Create a branch in your own fork to implement the changes. We recommend using the issue number as part of your branch name, e.g.: `1234-fixes`
30+
31+
1. Ensure that any documentation is updated with the changes that are required by your fix
32+
33+
1. Update README.md when necessary
34+
35+
1. Ensure that any samples are updated if the base image has been changed
36+
37+
1. Update CHANGELOG.md - add information about the changes that are done in this pull request, increment the version
38+
39+
1. Tag your branch with the new version
40+
41+
1. Submit the pull request. **Do not leave the pull request description 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 adding `#1234` to the description. We will assign the pull request to 2-3 people for review before it is merged.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,13 @@ echo "$uuid ${var.volume_mount_directory} ext4 defaults,noatime,_netdev,nofail
174174

175175
## Contributing
176176

177-
This project is open source. Oracle appreciates any contributions that are made by the open source community.
177+
This project is open source. Oracle appreciates any contributions that are made by the open source community.
178+
179+
Learn how to [contribute](CONTRIBUTING.md)).
178180

179181
## License
180182

181-
Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
183+
Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
182184

183185
Licensed under the Universal Permissive License 1.0 or Apache License 2.0.
184186

0 commit comments

Comments
 (0)