You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Ask your question here. Include any details relevant. Make sure you are not falling prey to the [X/Y problem][2]!
13
+
14
+
[2]: http://xyproblem.info
15
+
-->
16
+
17
+
### Other information
18
+
<!-- e.g. detailed explanation, stacktraces, related issues, suggestions on how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, etc -->
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+7-61
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
11
11
12
12
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
13
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-analytics-on-aws-web-sdk/issues), or [recently closed](https://github.com/aws-solutions/clickstream-analytics-on-aws-web-sdk/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
15
15
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
16
17
17
* A reproducible test case or series of steps
@@ -21,64 +21,6 @@ reported the issue. Please try to include as much information as you can. Detail
21
21
22
22
23
23
## Contributing via Pull Requests
24
-
25
-
This is mostly the same as [GitHub's guide on creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
26
-
27
-
First, create a _fork_ of `clickstream-web`. Clone it, and make changes to this _fork_.
See also: https://stackoverflow.com/a/58662077/695787
47
-
```
48
-
49
-
Now, save your work to a new branch:
50
-
51
-
```shell
52
-
git checkout -b feature_page_view
53
-
```
54
-
55
-
To publish it:
56
-
57
-
```shell
58
-
git push -u origin feature_page_view
59
-
```
60
-
61
-
This last step will give you a URL to view a GitHub page in your browser.
62
-
Copy-paste this, and complete the workflow in the UI. It will invite you to
63
-
"create a PR" from your newly published branch.
64
-
65
-
### Pull Request Guidelines
66
-
- The title of your PR must be descriptive to the specific change.
67
-
- The title of your PR must be of below format since next release version is determined from PR titles in the commit history.
68
-
- For a bugfix: `fix: description of changes`
69
-
- For a feature: `feat: add awesome feature`
70
-
- Everything else: `chore: fix build script`
71
-
- No period at the end of the title.
72
-
- Pull Request message should indicate which issues are fixed: `fixes #<issue>` or `closes #<issue>`.
73
-
- If not obvious (i.e. from unit tests), describe how you verified that your change works.
74
-
- If this PR includes breaking changes, they must be listed at the top of the changelog as described above in the Pull Request Checklist.
75
-
- PR must be reviewed by at least one repository maintainer, in order
76
-
to be considered for inclusion.
77
-
- PR must also pass the Actions like Checkstyle, Lint, and Unit tests.
78
-
- Usually all these are going to be **squashed** when you merge to main.
79
-
- Make sure to update the PR title/description if things change.
80
-
- Rebase with the `main` branch if it has commits ahead of your fork.
81
-
82
24
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
83
25
84
26
1. You are working against the latest source on the *main* branch.
@@ -99,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
99
41
100
42
101
43
## Finding contributions to work on
102
-
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-analytics-on-aws-web-sdk/labels/help%20wanted) issues is a great place to start.
103
45
104
46
105
47
## Code of Conduct
@@ -114,4 +56,8 @@ If you discover a potential security issue in this project we ask that you notif
114
56
115
57
## Licensing
116
58
117
-
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.
0 commit comments