Skip to content

Commit 11489aa

Browse files
authored
add v0.3.2 release to github (#21)
1 parent c406f3d commit 11489aa

18 files changed

+5098
-4128
lines changed

.yarnrc.yml

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
nodeLinker: node-modules
1+
compressionLevel: mixed
2+
3+
enableGlobalCache: false
4+
25
nmHoistingLimits: workspaces
36

4-
yarnPath: .yarn/releases/yarn-3.6.1.cjs
7+
nodeLinker: node-modules
8+
9+
yarnPath: .yarn/releases/yarn-4.5.3.cjs

CHANGELOG.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.3.2] - 2025-01-29
9+
10+
### Changed
11+
12+
- update solution name
13+
- move project to the aws-solutions GitHub account
14+
15+
### Security
16+
17+
- bump versions for cross-spawn, serve-static, and micromatch
18+
19+
## [0.3.1] - 2024-12-03
20+
21+
### Changed
22+
23+
- update Swift SDK dependency to version 0.12.5
24+
- update miscellaneous other dependencies

CONTRIBUTING.md

+7-101
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
1111

1212
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1313

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
14+
When filing an issue, please check [existing open](https://github.com/aws-solutions/clickstream-web/issues), or [recently closed](https://github.com/aws-solutions/clickstream-web/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
1515
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1616

1717
* A reproducible test case or series of steps
@@ -39,107 +39,9 @@ To send us a pull request, please:
3939
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4040
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4141

42-
## Development workflow
43-
44-
This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/features/workspaces). It contains the
45-
following packages:
46-
47-
- The library package in the root directory.
48-
- An example app in the `example/` directory.
49-
50-
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
51-
52-
```sh
53-
yarn
54-
```
55-
56-
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
57-
58-
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
59-
60-
It is configured to use the local version of the library, so any changes you make to the library's source code will be
61-
reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a
62-
rebuild, but native code changes will require a rebuild of the example app.
63-
64-
If you want to use Android Studio or XCode to edit the native code, you can open the `example/android` or `example/ios`
65-
directories respectively in those editors. To edit the Objective-C or Swift files,
66-
open `example/ios/ClickstreamReactNativeExample.xcworkspace` in XCode and find the source files
67-
at `Pods > Development Pods > clickstream-react-native`.
68-
69-
To edit the Java or Kotlin files, open `example/android` in Android studio and find the source files
70-
at `clickstream-react-native` under `Android`.
71-
72-
You can use various commands from the root directory to work with the project.
73-
74-
To start the packager:
75-
76-
```sh
77-
yarn example start
78-
```
79-
80-
To run the example app on Android:
81-
82-
```sh
83-
yarn example android
84-
```
85-
86-
To run the example app on iOS:
87-
88-
```sh
89-
yarn example ios
90-
```
91-
92-
Make sure your code passes TypeScript and ESLint. Run the following to verify:
93-
94-
```sh
95-
yarn run format
96-
yarn run lint
97-
```
98-
99-
To fix formatting errors, run the following:
100-
101-
```sh
102-
yarn lint --fix
103-
```
104-
105-
Remember to add tests for your change if possible. Run the unit tests by:
106-
107-
```sh
108-
yarn run test
109-
```
110-
111-
### Commit message rules
112-
113-
Please follow our commit messages rules:
114-
115-
- `fix`: bug fixes, e.g. fix crash due to deprecated method.
116-
- `feat`: new features, e.g. add new method to the module.
117-
- `docs`: changes into documentation, e.g. add usage example for the module..
118-
- `chore`: tooling changes, e.g. change project config.
119-
- `ci`: GitHub action changes, e.g. add test workflow.
120-
121-
### Linting and tests
122-
123-
[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
124-
125-
We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/)
126-
with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
127-
128-
### Scripts
129-
130-
The `package.json` file contains various scripts for common tasks:
131-
132-
- `yarn`: setup project by installing dependencies.
133-
- `yarn run format`: code format check for TypeScript.
134-
- `yarn run lint`: lint files with ESLint.
135-
- `yarn run test`: run unit tests with Jest.
136-
- `yarn example start`: start the Metro server for the example app.
137-
- `yarn example android`: run the example app on Android.
138-
- `yarn example ios`: run the example app on iOS.
139-
14042

14143
## Finding contributions to work on
142-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
44+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-solutions/clickstream-web/labels/help%20wanted) issues is a great place to start.
14345

14446

14547
## Code of Conduct
@@ -154,4 +56,8 @@ If you discover a potential security issue in this project we ask that you notif
15456

15557
## Licensing
15658

157-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
59+
See the [LICENSE](https://github.com/aws-solutions/%%SOLUTION_NAME%%/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
60+
61+
We may ask you to sign a [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
62+
63+

0 commit comments

Comments
 (0)