You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by "harikrishna-patnala (via GitHub)" <gi...@apache.org> on 2023/02/24 11:12:16 UTC

[GitHub] [cloudstack-terraform-provider] harikrishna-patnala commented on a diff in pull request #54: Added contribute document

harikrishna-patnala commented on code in PR #54:
URL: https://github.com/apache/cloudstack-terraform-provider/pull/54#discussion_r1116842660


##########
CONTRIBUTING.md:
##########
@@ -0,0 +1,139 @@
+Contributing to Apache CloudStack Terraform Provider (ACS)
+===========================================================
+
+Summary
+-------
+This document covers how to contribute to the ACS project. ACS uses GitHub PRs to manage code contributions. 
+These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to your own fork of the ACS project and you will submit a Pull Request for your changes to be added.
+
+_Lets get started!!!_
+
+Bug fixes
+---------
+
+It's very important that we can easily track bug fix commits, so their hashes should remain the same in all branches. 
+Therefore, a pull request (PR) that fixes a bug, should be sent against a release branch. 
+This can be either the "current release" or the "previous release", depending on which ones are maintained. 
+Since the goal is a stable main, bug fixes should be "merged forward" to the next branch in order: "previous release" -> "current release" -> main (in other words: old to new)
+
+Developing new features
+-----------------------
+
+Development should be done in a feature branch, branched off of main. 
+Send a PR(steps below) to get it into main (2x LGTM applies). 
+PR will only be merged when main is open, will be held otherwise until main is open again. 
+No back porting / cherry-picking features to existing branches!
+
+PendingReleaseNotes file
+------------------------
+When developing a new feature or making a (major) change to a existing feature you are encouraged to append this to the PendingReleaseNotes file so that the Release Manager can
+use this file as a source of information when compiling the Release Notes for a new release.
+
+When adding information to the PendingReleaseNotes file make sure that you write a good and understandable description of the new feature or change which you have developed.
+
+Updating the PendingReleaseNotes file is preferably a part of the original Pull Request, but that is up to the developers' discretion.
+
+Fork the code 
+-------------
+
+In your browser, navigate to: [https://github.com/apache/cloudstack](https://github.com/apache/cloudstack)

Review Comment:
   ```suggestion
   In your browser, navigate to: [https://github.com/apache/cloudstack-terraform-provider](https://github.com/apache/cloudstack-terraform-provider)
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@cloudstack.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org