Skip to content

Commit 0719f1a

Browse files
authored
Add docs dir (#4)
1 parent 5d66da7 commit 0719f1a

File tree

3 files changed

+39
-3
lines changed

3 files changed

+39
-3
lines changed

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@
1111
# dependencies
1212
/node_modules
1313

14-
# generated documentation
15-
/docs
16-
1714
# profiling files
1815
chrome-profiler-events.json
1916
speed-measure-plugin.json

docs/CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
We welcome contributions to the **Angular SDK** repository.
4+
5+
All participants are expected to adhere to the [Code of Conduct](../CODE_OF_CONDUCT.md) and treat each other with respect.
6+
7+
8+
Users and developers may create **issues** to report bugs or suggest new features.
9+
10+
Developers are welcome to also propose **fixes** and/or **new features or components** using the following contribution guidelines.
11+
12+
13+
## Workflow
14+
1. File an issue to notify the maintainers about what you're working on.
15+
2. Fork the repo, develop and test your code changes, add docs.
16+
3. Make sure that your commit messages clearly describe the changes.
17+
4. Send a pull request.
18+
19+
## Style Guides
20+
1. We attempt to follow the [Google TypeScript Style Guide](https://google.github.io/styleguide/tsguide.html)
21+
2. For our components, we attempt to match the coding style for [Angular Material](https://material.angular.io/) based on their code examples.
22+
23+
24+
## Make the Pull Request
25+
26+
Once you have made all your changes, tests, and updated the documentation,
27+
make a pull request to move everything back into the appropriate branch of the
28+
repository.
29+
30+
Be sure to reference the original issue in the pull request.
31+
32+
33+
## Run Tests
34+
35+
Since the Angular SDK requires interaction with a running Pega Infinity™ server, there is not an automated set of tests provided at this time.
36+
37+
We suggest you begin by using the **MediaCo** application provided in the [Angular SDK download](https://community.pega.com/marketplace/components/angular-sdk). Test your change by using the MediaCo application and completing a complete case flow using the **New Service** casetype provided in that sample application.
38+
39+
Alternately, if you are testing with your own application, provide a link from which maintainers can access your application. Please provide the maintainers with instructions on how they can run your application to confirm that your changes work as expected.

docs/media/AngularSDK-Logo.png

9.55 KB
Loading

0 commit comments

Comments
 (0)