Skip to content

Commit 10be39b

Browse files
drichardrichar
authored
Merge pull request #363 from algorandfoundation/dev
v1.1.0
2 parents 15184b9 + 51cf359 commit 10be39b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2938
-1507
lines changed

‎.github/pull_request_template.md

+21-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
1-
### Description
1+
## Description
22

3-
> _Please explain the changes you made here_
3+
<!-- Provide a clear and concise description of your changes -->
44

5-
### Checklist
5+
## Details
66

7-
> _Please, make sure to comply with the checklist below before expecting review_
7+
<!-- List the specific changes, improvements, or fixes implemented -->
88

9-
- [ ] Code compiles correctly
10-
- [ ] Created tests which fail without the change (if possible)
11-
- [ ] All tests passing
12-
- [ ] Extended the README / documentation, if necessary
9+
-
10+
-
11+
-
12+
13+
## Testing
14+
15+
<!-- Describe the tests you updated or added -->
16+
17+
- [ ] All existing tests pass
18+
- [ ] New tests added (if applicable)
19+
20+
## Documentation
21+
22+
<!-- Check if any documentation updates were required -->
23+
24+
- [ ] README.md updated (if applicable)
25+
- [ ] GitBook documentation updated (if applicable)

‎CONTRIBUTING.md

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Contributing to Réti Open Pooling
2+
3+
We love your input! We want to make contributing to Réti Open Pooling as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## Development Process
12+
13+
We use GitHub to host code, track issues and feature requests, and manage contributions. To contribute code changes:
14+
15+
1. Fork the repo and create your branch from `dev`.
16+
2. If you've added code that should be tested, add tests.
17+
3. If you've changed APIs, update the documentation.
18+
4. Ensure the test suite passes.
19+
5. Make sure your code lints.
20+
6. Issue that pull request!
21+
22+
## Pull Request Process
23+
24+
1. Update the README.md or relevant documentation with details of changes to the interface, if applicable.
25+
2. The PR title should follow our semantic commit message format (see below).
26+
3. Your pull request will be reviewed by the maintainers. Once approved, a maintainer will merge it.
27+
28+
## Commit Message Format
29+
30+
We follow very precise rules over how our Git commit messages should be formatted. This format leads to more readable messages that are easy to follow when looking through the project history.
31+
32+
Each commit message consists of a header, a body, and a footer:
33+
34+
```
35+
<type>(<scope>): <subject>
36+
<BLANK LINE>
37+
<body>
38+
<BLANK LINE>
39+
<footer>
40+
```
41+
42+
### Type
43+
44+
Must be one of the following:
45+
46+
- **feat**: A new feature
47+
- **fix**: A bug fix
48+
- **docs**: Documentation only changes
49+
- **style**: Changes that do not affect the meaning of the code
50+
- **refactor**: A code change that neither fixes a bug nor adds a feature
51+
- **perf**: A code change that improves performance
52+
- **test**: Adding missing or correcting existing tests
53+
- **chore**: Changes to the build process or auxiliary tools
54+
55+
### Scope
56+
57+
The scope could be anything specifying place of the commit change. For example:
58+
59+
- contracts
60+
- ui
61+
- nodemgr
62+
- docs
63+
64+
### Subject
65+
66+
The subject contains a succinct description of the change:
67+
68+
- use the imperative, present tense: "change" not "changed" nor "changes"
69+
- don't capitalize first letter
70+
- no dot (.) at the end
71+
72+
## Development Setup
73+
74+
Please refer to the [README.md](README.md) for detailed setup instructions, including:
75+
76+
- Prerequisites (Docker, AlgoKit, PNPM)
77+
- Quick start guide for local development
78+
- FNet development setup
79+
- Additional resources and documentation
80+
81+
The README contains the most up-to-date and complete instructions for getting the development environment running properly.
82+
83+
## Testing
84+
85+
- Run contract tests:
86+
87+
```bash
88+
cd contracts
89+
pnpm run test
90+
```
91+
92+
- Run UI tests:
93+
94+
```bash
95+
cd ui
96+
pnpm run test
97+
```
98+
99+
## Any contributions you make will be under the MIT Software License
100+
101+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
102+
103+
## Report bugs using GitHub's [issue tracker](https://github.com/algorandfoundation/reti/issues)
104+
105+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/algorandfoundation/reti/issues/new); it's that easy!
106+
107+
## Write bug reports with detail, background, and sample code
108+
109+
**Great Bug Reports** tend to have:
110+
111+
- A quick summary and/or background
112+
- Steps to reproduce
113+
- Be specific!
114+
- Give sample code if you can.
115+
- What you expected would happen
116+
- What actually happens
117+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
118+
119+
## Documentation
120+
121+
For detailed information about the protocol, its objectives, and technical implementation, please refer to our [GitBook documentation](https://txnlab.gitbook.io/reti-open-pooling).
122+
123+
## License
124+
125+
By contributing, you agree that your contributions will be licensed under the project's [MIT License](LICENSE).

‎contracts/bootstrap/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "bootstrap",
3-
"version": "1.0.3",
3+
"version": "1.1.0",
44
"description": "",
55
"main": "index.ts",
66
"scripts": {

‎contracts/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "reti-contracts",
3-
"version": "1.0.3",
3+
"version": "1.1.0",
44
"license": "MIT",
55
"scripts": {
66
"generate-client": "algokit generate client contracts/artifacts/ --language typescript --output contracts/clients/{contract_name}Client.ts && ./update_contract_artifacts.sh",

0 commit comments

Comments
 (0)