-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(oss): add indev warning, code of conduct, and contribution guide…
…lines
- Loading branch information
1 parent
1def34a
commit 02c7dac
Showing
3 changed files
with
91 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Code of Conduct | ||
This code of conduct outlines our expectations for all those who participate in | ||
our open source projects and communities (community programs), as well as the | ||
consequences for unacceptable behaviour. We invite all those who participate to | ||
help us create safe and positive experiences for everyone. Communities mirror | ||
the societies in which they exist and positive action is essential to counteract | ||
the many forms of inequality and abuses of power that exist in society. | ||
|
||
## How to behave | ||
The following behaviours are expected and requested of all community members: | ||
|
||
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. | ||
- Exercise consideration, respect and empathy in your speech and actions. Remember, we have all been through different stages of learning when adopting technologies. | ||
- Refrain from demeaning, discriminatory, or harassing behaviour and speech. | ||
- Disagreements on things are fine, argumentative behaviour or trolling are not. | ||
|
||
## How not to behave | ||
- Do not perform threats of violence or use violent language directed against another person. | ||
- Do not make jokes of sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory nature, or use language of this nature. | ||
- Do not post or display sexually explicit or violent material. | ||
- Do not post or threaten to post other people’s personally identifying information ("doxing"). | ||
- Do not make personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. | ||
- Do not engage in sexual attention. This includes, sexualised comments or jokes and sexual advances. | ||
- Do not advocate for, or encourage, any of the above behaviour. | ||
|
||
Please take into account that online communities bring together people from many | ||
different cultures and backgrounds. It's important to understand that sometimes | ||
the combination of cultural differences and online interaction can lead to | ||
misunderstandings. That is why having empathy is very important. | ||
|
||
## How to report issues | ||
If someone is acting inappropriately or violating this Code of Conduct in any | ||
shape or form, and they are not receptive to your feedback, or you prefer not to | ||
confront them, please reach out to us via [Discord](https://discord.gg/JR6Q8YVWX8). | ||
|
||
## Consequences of Unacceptable Behaviour | ||
Unacceptable behaviour from any community member will not be tolerated. Anyone | ||
asked to stop unacceptable behaviour is expected to comply immediately. If a | ||
community member engages in unacceptable behaviour, JetBrains and/or community | ||
organisers may take any action they deem appropriate, up to and including a | ||
temporary ban or permanent expulsion from the community without warning. | ||
|
||
## License and attribution | ||
The license is based off of The Citizen Code of Conduct is distributed by | ||
Stumptown Syndicate under a Creative Commons Attribution-ShareAlike license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Contributing to KRAFT | ||
|
||
Contributions are always welcome in any form! Please remember to follow the | ||
[Code of Conduct](CODE_OF_CONDUCT.md) when contributing to this project. | ||
|
||
Meaningful contributions can come in many forms, including but not limited to: | ||
- Reporting bugs | ||
- Suggesting new features | ||
- Fixing bugs | ||
- Implementing new features | ||
- Improving documentation | ||
- Writing tests | ||
- Reviewing code | ||
- Providing feedback | ||
- Sharing the project with others | ||
- And more! | ||
|
||
## Recommended Tools | ||
|
||
The following tools are recommended for contributing to this project: | ||
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) | ||
|
||
## Recommended Knowledge | ||
|
||
Before contributing to this project, it is recommended to have a high level understanding of the following: | ||
- [Kotlin](https://kotlinlang.org/) | ||
- [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) | ||
- [Microservices Architecture](https://microservices.io/) (This project does not strictly adhere to microservices architecture, but it is still recommended to have a high level understanding of how it works) | ||
- [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) | ||
|
||
KRAFT is a large, multifaceted set of tools. Some other beneficial knowledge includes: | ||
- [Hyper Text Transfer Protocol (HTTP)](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) | ||
|
||
This list is not exhaustive, and contributions are welcome from anyone with any level of experience. It | ||
will be updated as the project grows and more knowledge becomes necessary. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters