Skip to content

Commit

Permalink
docs(*): update markdown files and fix typos - I257
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Zhou <[email protected]>
  • Loading branch information
michizhou authored and jolanglinais committed Oct 19, 2019
1 parent a769569 commit 2321bd3
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Cicero

> Thanks to the angularJS team for the bulk of this text!
> Thanks to the AngularJS team for the bulk of this text!
We'd love for you to contribute to our source code and to make Cicero even better than it is
today! Here are the guidelines we'd like you to follow:
Expand Down Expand Up @@ -49,15 +49,15 @@ If you find a bug in the source code, you can help us by submitting an issue to

### <a name="feature"></a> Missing a Feature?

You can request a new feature by submitting an issue to our [GitHub Repository][github-issues].
You can request a new feature by [submitting an issue][github-issues] to our GitHub Repository.

If you would like to implement a new feature then consider what kind of change it is:

* **Major Changes** that you wish to contribute to the project should be discussed first in an
[GitHub issue][github-issues] that clearly outlines the changes and benefits of the feature.
* **Small Changes** can directly be crafted and submitted to the [GitHub Repository][github]
as a Pull Request. See the section about [Pull Request Submission Guidelines][contribute.submitpr], and
for detailed information the [core development documentation][developers].
for detailed information read the [core development documentation][developers].

### <a name="docs"></a> Want a Doc Fix?

Expand Down Expand Up @@ -93,7 +93,7 @@ make it easier to understand and categorize the issue.
Before you submit your pull request consider the following guidelines:

* Ensure there is an open [Issue][github-issues] for what you will be working on. If there is not, open one up by going through [these guidelines][contribute.submit].
* Search [GitHub][pulls] for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
* Search for an open or closed [Pull Request][pulls] that relates to your submission. You don't want to duplicate effort.
* Create the [development environment][developers.setup]
* Make your changes in a new git branch:

Expand All @@ -111,7 +111,7 @@ Before you submit your pull request consider the following guidelines:
* Follow our [Coding Rules][developers.rules].
* Ensure you provide a DCO sign-off for your commits using the -s option of git commit. For more information see [how this works][dcohow].
* If the changes affect public APIs, change or add relevant [documentation][developers.documentation].
* Run the [unit][developers.unit-tests] test suite, and ensure that all tests pass.
* Run the [unit test suite][developers.unit-tests], and ensure that all tests pass.

* Commit your changes using a descriptive commit message that follows our [commit message conventions][developers.commits]. Adherence to the [commit message conventions][developers.commits] is required, because release notes are automatically generated from these messages.

Expand All @@ -121,7 +121,7 @@ Before you submit your pull request consider the following guidelines:

Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

* Before creating the Pull Request, ensure your branch sits on top of master (as opposed to branch off a branch). This ensures the reviewer will need only minimal effort to integrate your work by fast-fowarding master:
* Before creating the Pull Request, ensure your branch sits on top of master (as opposed to branch off a branch). This ensures the reviewer will need only minimal effort to integrate your work by fast-forwarding master:

```text
git rebase upstream/master
Expand Down Expand Up @@ -154,7 +154,7 @@ Before you submit your pull request consider the following guidelines:
git push origin name-issue-tracker-short-description -f
```
This is generally easier to follow, but seperate commits are useful if the Pull Request contains iterations that might be interesting to see side-by-side.
This is generally easier to follow, but separate commits are useful if the Pull Request contains iterations that might be interesting to see side-by-side.
That's it! Thank you for your contribution!
Expand Down
2 changes: 1 addition & 1 deletion DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ The subject contains succinct description of the change:
* no dot (.) at the end

### Footer
The footer should contain [reference GitHub Issues that this commit addresses][github-issues].
The footer should contain [reference GitHub Issues][github-issues] that this commit addresses.

## <a name="pullrequests"></a> GitHub Pull Request Guidelines
Pull Requests should consist of a complete addition to the code which contains value.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,5 +324,5 @@ Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respec
[contributing]: https://github.com/accordproject/cicero/blob/master/CONTRIBUTING.md
[developers]: https://github.com/accordproject/cicero/blob/master/DEVELOPERS.md

[apache]: https://github.com/accordproject/template-studio-v2/blob/master/LICENSE
[apache]: https://github.com/accordproject/cicero/blob/master/LICENSE
[creativecommons]: http://creativecommons.org/licenses/by/4.0/

0 comments on commit 2321bd3

Please sign in to comment.