Skip to content

Commit 11a4b59

Browse files
djenczewskidjenczewski
authored
Release 2.2.0
Release 2.2.0
2 parents 89caa81 + af43c08 commit 11a4b59

File tree

166 files changed

+21515
-0
lines changed

Some content is hidden

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

166 files changed

+21515
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yaml‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
title: "[BUG]: "
4+
labels: [ 'bug' ]
5+
assignees:
6+
- "djenczewski"
7+
body:
8+
- type: textarea
9+
id: Description
10+
attributes:
11+
label: Description
12+
placeholder: Briefly describe the issue.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: Steps-to-Reproduce
17+
attributes:
18+
label: Steps to Reproduce
19+
placeholder: "1. Go to '...'
20+
21+
2. Click on '...'
22+
23+
3. Scroll to '...'
24+
25+
4. Observe the error.
26+
"
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: Expected-Behavior
31+
attributes:
32+
label: Expected Behavior
33+
placeholder: "Describe what you expected to happen."
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: Screenshots-or-Logs
38+
attributes:
39+
label: Screenshots or Logs
40+
placeholder: "If applicable, attach screenshots or relevant logs to help illustrate the issue."
41+
- type: textarea
42+
id: Additional-Context
43+
attributes:
44+
label: Additional Context
45+
placeholder: Add any other context about the problem here.
46+
- type: markdown
47+
id: Device-Details
48+
attributes:
49+
value: "## **Device Details**"
50+
- type: input
51+
id: Device
52+
attributes:
53+
label: Device
54+
placeholder: "Google Pixel 9"
55+
- type: input
56+
id: Os-Version
57+
attributes:
58+
label: Operating system and version
59+
placeholder: "Android 15"
60+
- type: input
61+
id: cpu-arch
62+
attributes:
63+
label: CPU Architecture or Android ABI
64+
placeholder: "x86 / arm64-v8a"
65+
- type: markdown
66+
id: package-used
67+
attributes:
68+
value: "## **Endpoint Library Used**"
69+
- type: dropdown
70+
id: package-name
71+
attributes:
72+
label: Package name
73+
options:
74+
- PrivMX Endpoint
75+
- PrivMX Endpoint Extra
76+
validations:
77+
required: true
78+
- type: input
79+
id: package-version
80+
attributes:
81+
label: Package version
82+
placeholder: ">=2.0 / 2.0.5"
83+
validations:
84+
required: true
85+
- type: markdown
86+
id: Project-Details
87+
attributes:
88+
value: "## **Project Details**"
89+
- type: input
90+
id: Language
91+
attributes:
92+
label: Language
93+
placeholder: "Java 21 / Kotlin 2.0"
94+
- type: input
95+
id: Environment-Version
96+
attributes:
97+
label: Environment
98+
placeholder: "Android Studio Ladybug 2024.2.2"
99+
- type: markdown
100+
attributes:
101+
value: "## **Optionally**"
102+
- type: input
103+
attributes:
104+
label: "Link to the reproducible code repository."
105+
- type: textarea
106+
attributes:
107+
label: Include the specific code block causing the error in a code snippet
108+
render: kotlin

‎.github/ISSUE_TEMPLATE/feature-request.yaml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "[FEATURE]:"
4+
labels: [ 'enhancement' ]
5+
assignees:
6+
- "djenczewski"
7+
body:
8+
- type: textarea
9+
id: Problem
10+
attributes:
11+
label: Problem
12+
placeholder: Briefly describe the problem your feature request addresses.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: Proposed-Solution
17+
attributes:
18+
label: Proposed Solution
19+
placeholder: Describe the desired solution clearly and concisely.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: Alternatives-Considered
24+
attributes:
25+
label: Alternatives Considered
26+
placeholder: Describe any alternative solutions or features you have thought about.
27+
- type: textarea
28+
id: Additional-Context
29+
attributes:
30+
label: Additional Context
31+
placeholder: Add any other context or attach screenshots related to the feature request here.
32+
- type: checkboxes
33+
id: feature-request-unique-confirmation
34+
attributes:
35+
label: "Search the feature requests assigned to this project to ensure you're not duplicating."
36+
options:
37+
- label: I confirm that this feature request has not already been logged.
38+
required: true

‎.gitignore‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
*.iml
2+
.gradle
3+
.idea
4+
.DS_Store
5+
build
6+
captures
7+
.externalNativeBuild
8+
.cxx
9+
local.properties
10+
xcuserdata
11+
.kotlin
12+
#So we don't accidentally commit our private keys
13+
*.gpg
14+
local.properties

‎CONTRIBUTING.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing to PrivMX
2+
3+
## Welcome Contributors! 🎉
4+
5+
Thank you for your interest in contributing to our project. This document provides guidelines and instructions for contributing.
6+
7+
## Legal Notice
8+
9+
If you want to contribute to the project, you can clone the repository, make changes, and then submit a Pull Request (follow the guidelines below).
10+
Submitting Pull Requests to SIMPLITO's repositories is the only way of publishing modifications made to our code allowed by our License.
11+
**All the code contributed to the project is under full commercial ownership of SIMPLITO.**
12+
13+
- [Licensing information](https://privmx.dev/licensing)
14+
- [Contact us](https://privmx.com/en/contact-us) in case of further questions.
15+
16+
## How Can You Contribute?
17+
18+
### Reporting Bugs 🐛
19+
20+
1. **Check Existing Issues**, before submitting a bug report.
21+
2. **Provide Detailed Information**, according to the bug report template in each project.
22+
23+
### Feature Requests 💡
24+
25+
1. **Check Existing Suggestions**: Verify that your feature hasn't been suggested before.
26+
2. **Open a Clear Issue**, describing it according to the feature request template in each project.
27+
3. (Optional) **Open a discussion**, if you want to discuss or make sure that the feature is actually necessary.
28+
29+
### Coding Guidelines 💻
30+
31+
- Follow the project's coding style and conventions
32+
- Write clear, concise, and well-documented code
33+
- Include comments for complex logic
34+
35+
### Commit Message Conventions
36+
37+
- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
38+
- Reference issue numbers when applicable
39+
40+
### Pull Request Process
41+
42+
1. **Prepare Your Changes**
43+
44+
- Ensure code follows project guidelines
45+
- Add/update tests as needed
46+
- Update documentation in code
47+
48+
2. **Submit Pull Request**
49+
50+
- Title should be clear and descriptive
51+
- Include a detailed description of changes
52+
- Link any related issues
53+
54+
3. **Code Review**
55+
- Maintainers will review your PR
56+
- Be open to feedback and suggested changes
57+
- Discussions and iterations are part of the process
58+
59+
## Semantic Versioning Rules (A.B.C-rcX)
60+
61+
- **New Features**: Increment `A` (major) for major changes or incompatible features, `B` (minor) for minor changes (mostly compatible with previous versions).
62+
- **Consistency**: Main library and wrappers use the same `A` and `B` versioning.
63+
- **Updates**: `C` changes are fixes and updates without new features; `C` doesn't need to be synchronized between library and wrappers.
64+
- **Release Candidate (rc)**: `X` represents consecutive release candidates for a given version.
65+
- **Before Official Release**: Release as `A.B.C-rcX` before final release; changes to new API are possible and update `X`.
66+
- **Finalizing a Version**: Release stable version when library and wrappers are fully compatible.
67+
- **Minor Changes (B)**: Increment `B` for small features, replace older functionality, and mark deprecated functions.
68+
- **Major Changes (A)**: Increment `A` for introducing major changes or features.
69+
70+
Read more about versioning in PrivMX in [our docs](https://docs.privmx.dev/docs/latest/start/versioning).
71+
72+
## Additional Resources
73+
74+
- [PrivMX Documentation](https://docs.privmx.dev/)
75+
- [API Reference](https://docs.privmx.dev/docs/latest/start/api-reference)
76+
77+
## Questions?
78+
79+
If you have any questions, please:
80+
81+
- Check the documentation
82+
- Open an issue or a discussion in the appropriate repository
83+
84+
---
85+
86+
**Thank you for contributing!** 🚀

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Simplito
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)