This is an automated email from the ASF dual-hosted git repository.
dahn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack.git
The following commit(s) were added to refs/heads/main by this push:
new 0934fb1b53e docs: fix grammar and spelling in CONTRIBUTING.md (#10642)
0934fb1b53e is described below
commit 0934fb1b53e2af4d75ff33cd4951c56e79b83db1
Author: John Bampton <[email protected]>
AuthorDate: Wed Apr 2 22:32:16 2025 +1000
docs: fix grammar and spelling in CONTRIBUTING.md (#10642)
---
CONTRIBUTING.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a6d006938f3..17ff4badc97 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,9 +4,9 @@ Contributing to Apache CloudStack (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.
+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!!!_
+_Let's get started!!!_
Bug fixes
---------
@@ -26,7 +26,7 @@ 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
+When developing a new feature or making a (major) change to an 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.
@@ -38,9 +38,9 @@ Fork the code
In your browser, navigate to:
[https://github.com/apache/cloudstack](https://github.com/apache/cloudstack)
-Fork the repository by clicking on the 'Fork' button on the top right hand
side. The fork will happen and you will be taken to your own fork of the
repository. Copy the Git repository URL by clicking on the clipboard next to
the URL on the right hand side of the page under '**HTTPS** clone URL'. You
will paste this URL when doing the following `git clone` command.
+Fork the repository by clicking on the 'Fork' button on the top right hand
side. The fork will happen, and you will be taken to your own fork of the
repository. Copy the Git repository URL by clicking on the clipboard next to
the URL on the right hand side of the page under '**HTTPS** clone URL'. You
will paste this URL when doing the following `git clone` command.
-On your computer, follow these steps to setup a local repository for working
on ACS:
+On your computer, follow these steps to set up a local repository for working
on ACS:
```bash
$ git clone https://github.com/YOUR_ACCOUNT/cloudstack.git
@@ -92,9 +92,9 @@ $ git rebase main
Make a GitHub Pull Request to contribute your changes
-----------------------------------------------------
-When you are happy with your changes and you are ready to contribute them, you
will create a Pull Request on GitHub to do so. This is done by pushing your
local changes to your forked repository (default remote name is `origin`) and
then initiating a pull request on GitHub.
+When you are happy with your changes, and you are ready to contribute them,
you will create a Pull Request on GitHub to do so. This is done by pushing
your local changes to your forked repository (default remote name is `origin`)
and then initiating a pull request on GitHub.
-Please include JIRA id, detailed information about the bug/feature, what all
tests are executed, how the reviewer can test this feature etc. Incase of UI
PRs, a screenshot is preferred.
+Please include JIRA id, detailed information about the bug/feature, what all
tests are executed, how the reviewer can test this feature etc. In case of UI
PRs, a screenshot is preferred.
> **IMPORTANT:** Make sure you have rebased your `feature_x` branch to include
> the latest code from `upstream/main` _before_ you do this.
