Skip to content

Commit b88ce19

Browse files
authored
Merge pull request #13 from infinum/feature/v2/base
Feature/v2/base
2 parents 288425f + 0678dab commit b88ce19

20 files changed

+975
-363
lines changed

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Code of conduct
2+
3+
## Our pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71+
available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
72+
73+
For answers to common questions about this code of conduct, visit
74+
the [FAQ](https://www.contributor-covenant.org/faq) page.

CONTRIBUTING.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing guidelines
2+
3+
Welcome to our project! We appreciate your interest in helping us improve it.
4+
5+
## How can I contribute?
6+
7+
There are multiple ways in which you can help us make this project even better.
8+
9+
- Reporting bugs or suggesting new features
10+
- Contributing code improvements or new features
11+
- Writing, updating, or fixing tests
12+
- Improving documentation, including inline comments, user manuals, and developer guides
13+
14+
## Issue reporting
15+
16+
If you found a bug or have an idea for a new feature, please open an issue. Be sure to include a clear and descriptive title, as well as a detailed description of the bug or feature.
17+
18+
To avoid duplicate issues, please check if a similar issue has already been created.
19+
20+
## Making changes
21+
22+
To make changes to the project, please follow these steps:
23+
24+
1. Fork the project repository.
25+
2. Create a new branch for your changes, based on the project's main branch.
26+
3. Make your changes. Ensure you've followed the coding style and standards.
27+
4. Test your changes thoroughly, ensuring all existing tests pass and new tests cover your changes where appropriate.
28+
5. Commit your changes with a clear and descriptive commit message.
29+
6. Push your changes to your fork.
30+
7. Create a pull request to the project's main branch.
31+
32+
Once we check everything, we will merge the changes into the main branch and include it in the next release.
33+
34+
## Guidelines for pull requests
35+
36+
When submitting a pull request, please ensure that:
37+
38+
- Your pull request is concise and well-scoped
39+
- Your code is properly tested
40+
- Your code adheres to the project's coding standards and style guidelines
41+
- Your commit message is clear and descriptive
42+
- Your pull request includes a description of the changes you have made and why you have made them
43+
44+
Try to avoid creating large pull requests that include multiple unrelated changes. Instead, break them down into smaller, more focused pull requests. This will make it easier for us to review and merge your changes.
45+
46+
## Code of conduct
47+
48+
We want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [code of conduct](/CODE_OF_CONDUCT.md).
49+
50+
## License
51+
52+
By submitting a pull request you agree to release that code under the project's [license](/LICENSE).

LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2020 Infinum
189+
Copyright 2024 Infinum
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.
@@ -198,4 +198,4 @@
198198
distributed under the License is distributed on an "AS IS" BASIS,
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201-
limitations under the License.
201+
limitations under the License.

0 commit comments

Comments
 (0)