Skip to content

Commit

Permalink
docs: Update README and Contributing (#2191)
Browse files Browse the repository at this point in the history
  • Loading branch information
JKMarkowski committed Mar 19, 2020
1 parent a8ba764 commit 5981d78
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,10 +338,11 @@ Full description of current CI PipeLine can be found [here](https://github.com/S
To ensure consistency throughout the source code, keep these rules in mind as you are working:

* All features or bug fixes **must be tested** by one or more specs (unit-tests).
* All public API methods **must be documented**. (Details TBC).
* All public API methods **must be documented**. [Documentation Guideline](https://github.com/SAP/fundamental-ngx/wiki/Documenting-Code)
* We follow [Google's JavaScript Style Guide][js-style-guide], but wrap all code at
**100 characters**. An automated formatter is available, see
[DEVELOPER.md](docs/DEVELOPER.md#clang-format).
* Rules are also mentioned in our [Code Contribution Guideline](https://github.com/SAP/fundamental-ngx/wiki/Code-Contribution-Guideline)


## <a name="cla"></a> Signing the CLA
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Prior knowledge of Angular is recommended, to use the fundamental-ngx library.

## <a name="3"></a>3. Known Issues

Please see [Issues](https://github.com/SAP/fundamental-ngx/issues).
* Please see [Issues](https://github.com/SAP/fundamental-ngx/issues).
* Contribution Known [Issues](https://github.com/SAP/fundamental-ngx/wiki/Known-Contribution-Issues)

## <a name="4"></a>4. Support

Expand Down

0 comments on commit 5981d78

Please sign in to comment.