Skip to content

Commit 5159b91

Browse files
posplawposplaw
committed
Merge branch 'main'
Conflicts: README.md
2 parents f433a61 + 79d507b commit 5159b91

File tree

4 files changed

+260
-0
lines changed

4 files changed

+260
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
info@sublab.dev.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing to Sublab's SCALE codec repository for Swift
2+
3+
## Intro
4+
5+
We, at Sublab, would love to have more mobile developers coming into Substrate ecosystem development. And while we're trying to produce as much as possible reliable and stable codebase, we still cannot cover all potential issues Substrate developers would need to solve, and we might have some bugs 🐞
6+
7+
So we encourage you to help us on this long journey by opening yet unknown issues or by contributing with your ideas in pull requests.
8+
9+
## Primary designation of this repository
10+
11+
This is a Swift repository which implements [Parity's SCALE codec](https://docs.substrate.io/reference/scale-codec/) in a designated way.
12+
13+
This repository aims to provide easy to use interface using Swift's Codable family of protocols via natively formatted SCALE Encoder and Decoder.
14+
15+
Unfortunately, Swift misses reflection and static size array in it and to avoid Objective-C backed types usage we generated static size arrays for sizes from 1 to 256 and using some workarounds for existing types like *enum* with *CodingKey*.
16+
17+
## Reporting issues
18+
19+
If you have encountered malfunctioning behavior of our produced codebase, please feel free to open an Issue under [Issues section](https://github.com/sublabdev/scale-codec-swift/issues) with Bug Report template type on this GitHub repository.
20+
21+
To ensure that we can reproduce your issue, please consider providing us with next information of your Issue:
22+
23+
- Version of library you're using, or if you include our library with your own fork, please provide the link to your public GitHub repository with either hash of the commit, or actual branch where you do your changes.
24+
- Environment where do you use our library: iOS, macOS, or any other Apple OS application, or even Linux/Windows.
25+
- Version of your environment: iOS version, iPadOS version, etc.
26+
- OS of your development machine: macOS/Linux/Windows version.
27+
- Type of your device if it's iPhone or iPad: model number or name
28+
- IDE that you use for development, like Xcode or AppCode
29+
- What method did you use to use our library: CocoaPods, Carthage, Swift Package Manage, or added it as sub-repository.
30+
- As many as possible: logs, crash stack traces, screenshots, and whatnot.
31+
- If you have a sample application to reproduce the issue, please include the link to your sample app (preferably GitHub public repo).
32+
- If this issue significantly affects your application and/or business, or blocks you from future development, please mention this so we can properly align our piorities to assist you with that.
33+
34+
Furthermore, we encourage you to report your created issue in our Telegram channel: [t.me/sublabsupport](http://t.me/sublabsupport) so we could assist you in the real time.
35+
36+
## New functionality
37+
38+
If you find our library very useful, which we would love to see, but still miss some functionality, please feel free to open an Issue under [Issues section](https://github.com/sublabdev/scale-codec-swift/issues) with Feature Request template type on this GitHub repository.
39+
40+
To better understand your feature, please don't mind to provide next information:
41+
42+
- What platform do you seek to have this functionality for: we haven't tested our library on every possible platform, and maybe this is not yet compatible.
43+
- If there is a reference from other application or a library, please provide the link to it.
44+
- Don't hesitate to explain your feature detailed. The longer is it, the easier it will be for us to understand the whole idea.
45+
- If you have an experience in Swift or Objective-C development and would like to assist us, but not sure about architectural solution, please mention this, we might support your feature implementation by extensively reviewing your code and suggesting new implementation ideas.
46+
47+
Same as for bugs, feel free to contact us via Telegram at [t.me/sublabsupport](http://t.me/sublabsupport) to discuss your ideas in chat.
48+
49+
## Submitting your code
50+
51+
We have limited resources, therefore we would appreciate this if anybody could help us by developing some small or not so small features to our library.
52+
53+
If you have developed a feature, please post this under [Pull Requests section](https://github.com/sublabdev/scale-codec-swift/pulls) of our GitHub repository, and don't forget about some rules:
54+
55+
- If there is an Issue on our Issues section, please provide link to it, and don't forget to mention its number on your branch.
56+
- However, if your feature is big enough and you don't have an Issue on our public GitHub repository, this would take significant amount of time and effort for us to discover your code and understand its designation. So to avoid long conversations and delaying your feature release, please look into making a feature Issue prior to actual development.
57+
- Don't forget to provide voluminous description so that we can skip part where we would've spent extra time trying to understand your work.
58+
- Every contribution should be provided as a pull request from fork of our library on your own personal account or bussiness account if you're a company.
59+
- Please ensure that your code aligns with our current license which is Apache 2.0, and you agree with its terms for the code your develop for this library.
60+
- Even though we do not have coding guidelines or standards yet, we still would love to see your Pull Request to match our existing coding standard with the same padding, line break rules, and so on. Please note, that we do make only Swift based code in this repository, so this is a strict requirement with some exceptions (like when C/C++ or Rust code is to be interop-ed).
61+
- Be ready for our team to ask for clarifications of some parts of your code or to request making changes to match our code style or to optimize the code.
62+
- We do not guarantee that your pull request will be merged, and same we don't guarantee that in case of rejection we won't reuse your code base eventually if we find it useful. At that time we might have complicated changes inside our codebase and your pull request might be slightly outdated. But we could contact you later to assist on migration if we find this useful.
63+
- Every pull request should have unit tests that cover whole written functionality and its stability of execution. Please use our commonly shared *testsCount* number to highly load your unit tests, but if it does some huge computing job inside, feel free to lower the number by either providing separate constant or lowering it inside your test class. For high computing jobs we consider single test execution time under 5-10 minutes as a top bar. If tests do not pass, we won't approve changes unless it's fixed.
64+
- If your feature is time sensitive and affects your current application and/or business, please mention this, so we can prioritize your pull request respectively.
65+
66+
## Contacting us
67+
68+
If neither of above solves your current problem, please feel free to contact us via our Telegram chat or by writing us via e-mail. We honor every incoming request and it's our duty to help to relax your Substrate development routine.
69+
70+
Our contacts:
71+
72+
- Telegram support chat: [t.me/sublabsupport](http://t.me/sublabsupport)
73+
- E-mail: [info@sublab.dev](mailto:info@sublab.dev)
74+
- Our Twitter, yes you can tweet us: https://twitter.com/sublabdev

0 commit comments

Comments
 (0)