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
We appreciate your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3
4
4
5
- Reporting a bug
@@ -8,9 +9,11 @@ We appreciate your input! We want to make contributing to this project as easy a
8
9
- Becoming a maintainer
9
10
10
11
## We Develop with Github
12
+
11
13
We use github to host code, to track issues and feature requests, as well as accept pull requests.
12
14
13
15
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16
+
14
17
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
15
18
16
19
1. Fork the repo and create your branch from `master`.
@@ -22,6 +25,7 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
22
25
7. Issue that pull request!
23
26
24
27
In general pull requests should:
28
+
25
29
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
26
30
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
27
31
- Address a single concern in the least number of changed lines as possible.
@@ -30,9 +34,11 @@ In general pull requests should:
30
34
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
31
35
32
36
## Any contributions you make will be under the ISC Software License
37
+
33
38
In short, when you submit code changes, your submissions are understood to be under the same [ISC License](https://choosealicense.com/licenses/isc/) that covers the project. Feel free to contact the maintainers if that's a concern.
34
39
35
40
## Report bugs using Github's issues
41
+
36
42
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/aeternity/aepp-calldata-js/issues); it's that easy!
37
43
38
44
## Write bug reports with detail, background, and sample code
@@ -41,20 +47,21 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
41
47
42
48
- A quick summary and/or background
43
49
- Steps to reproduce
44
-
- Be specific!
45
-
- Give sample code if you can.
50
+
- Be specific!
51
+
- Give sample code if you can.
46
52
- What you expected would happen
47
53
- What actually happens
48
54
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
49
55
50
-
People *love* thorough bug reports. Badly reported issues and bug report might be closed without review.
56
+
People _love_ thorough bug reports. Badly reported issues and bug report might be closed without review.
51
57
52
58
## Use a Consistent Coding Style
53
59
54
-
* 4 spaces for indentation rather than tabs
55
-
* this library is using vanilla javascript
56
-
* no complication/build phases are accepted
57
-
* it must support recent major platforms and browsers according to [Can I Use](https://caniuse.com)
60
+
- 4 spaces for indentation rather than tabs
61
+
- this library is using vanilla javascript
62
+
- no complication/build phases are accepted
63
+
- it must support recent major platforms and browsers according to [Can I Use](https://caniuse.com)
58
64
59
65
## License
66
+
60
67
By contributing, you agree that your contributions will be licensed under its ISC License.
0 commit comments