Skip to content

Commit

Permalink
feat(oss): add indev warning, code of conduct, and contribution guide…
Browse files Browse the repository at this point in the history
…lines
  • Loading branch information
LizAinslie committed Oct 30, 2024
1 parent 1def34a commit 02c7dac
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 0 deletions.
45 changes: 45 additions & 0 deletions CODE_OF_CONDUCT.md
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.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
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.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,16 @@ care of loading and processing services and service calls in the correct order,
while also ensuring services are kept in scope only as long as they are required
to prevent memory leaks.

## ⚠️ Danger Ahead!
This project is still in the early stages of development and is not yet ready
for production use. It is not recommended to use this project in a production
environment until this warning is removed.

## Looking to Contribute?
Contributions are always welcome! If you would like to contribute to this
project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more
information on how to get started. And thank you for your interest in this
project!

## License
This project is provided under the [MIT license](LICENSE).

0 comments on commit 02c7dac

Please sign in to comment.