diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 79ff6d62..9d674619 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,97 +1,3 @@ # audapolis Code of Conduct -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -- Demonstrating empathy and kindness toward other people -- Being respectful of differing opinions, viewpoints, and experiences -- Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -- Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -- The use of sexualized language or imagery, and sexual attention or - advances of any kind -- Trolling, insulting or derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or email - address, without their explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -bugbakery@riseup.net[^note]. You can also reach out to individual community -leaders directly via the contact methods on their profiles: - -[^note]: - This email is read by all community leaders of the vegan bug bakery, - not just the audapolis community leaders named below. - -- [pajowu](https://github.com/pajowu) -- [anuejn](https://github.com/anuejn) - -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated. - -Anyone asked to stop unacceptable behavior is expected to comply immediately. - -If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event). - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html and the -Citizen Code of Conduct as distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) -under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org +Please see [The Vegan Bug Bakery 🐛 Code of Conduct](https://github.com/bugbakery/bugbakery/blob/main/CODE_OF_CONDUCT.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82796d56..79fb568a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,81 +1,3 @@ # Contributing to audapolis -💖 First of all: thank you for contributing to audapolis - -This document contains some resources which should help you in doing that. - -## Code Of Conduct - -Everyone who contributes to audapolis must follow [our code of conduct](https://github.com/bugbakery/audapolis/blob/main/CODE_OF_CONDUCT.md). -If you notice any violations, please reach out to us via the ways described in the code of conduct. - -## How to Contribute - -### Report a bug - -Oops 😅 Thank you for catching a bug 🐛. -Please report this bug to us: - -1. Ensure the bug was not already reported by searching through our [Issues](https://github.com/bugbakery/audapolis/issues). -2. If you can't find a bug report for your bug, please [open a new one](https://github.com/bugbakery/audapolis/issues/new). Please include **a title and clear description** and if possible as much of the following if possible: - -- what one has to do to encounter the bug (**steps to reproduce**) -- what should have happened (**expected behaviour**) -- what happened instead (**actual behaviour**) -- anything else that might be relevant (**more information**) - -For more information on how to write a good bug report, [check out the atom contribution guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report) - -### "Audapolis should to X" or is behaving weird / unintuitively / not doing what you want? - -If audapolis is behaving unintuitively, feels weird, doesn't do something you think it should or similar, please [open an issue](https://github.com/bugbakery/audapolis/issues/new) if there doesn't exist one yet. - -We cannot guarantee that we can implement every feature you want, but we are always happy to discuss them and try to figure out how they might fit into audapolis. - -If you cannot figure out how to do something with audapolis you should be able to do, we consider [this a bug](#report-a-bug). - -### I don't understand the documentation - -If the documentation is unintuitive, we consider [this a bug](#report-a-bug). -If the documentation is missing something, we consider [this a bug](#report-a-bug). -If the documentation does not make you happy, we consider [this a bug](#report-a-bug). - -### Write code / documentation to close issues - -If you want to write code or documentation, please take a look at our issues. -We try to make them somewhat clear, but if you do not understand what an issue means, please ask us. -We sometimes tag issues as "good first issue", these could be interesting if this is you first contribution. - -You can find instruction on how to set up a development environment in the [app/README.md](app/README.md) file. - -If you have an issue that you understand and want to work on, feel free to do so. If you leave a short message in the issue thread, we can make sure that we do not have multiple people working on the same issue. - -Once you have a fix, [open a new pull request](https://github.com/bugbakery/audapolis/compare). -We will try to review your pull request as quick as possible. - -To make sure we can merge it quickly, you can do a few things to help us: - -1. Please make sure that the PR description includes all information we need to review this pull request (for example the issue this fixes, how it works). -2. Make sure that [our linters](https://pre-commit.com/) pass (for example by running `pre-commit` and/or `pre-commit run --all-files`) -3. Make sure that branch can be merged into the main branch - -### Write code for new features - -If you want to write code for something that is not already [described in an issue](https://github.com/bugbakery/audapolis), please open an issue first and communicate that you are working on it. -Especially if it's more than a small bugfix for an obvious bug. -We might have some opinions on whether / how your feature should be included into audapolis. - -If you do not open an issue first, we might have a lot of review comments that need to be addressed before we can merge your pull request or even have to close the PR entirely because we do not want to include the feature. - -Opening an issue first also allows other users to comment on it, often leading to a better result. - -### Write tests & domentation - -If you want to write tests & documentation for existing features / behaviour, always feel free to do so and open a pull request. -Here, we would also appreachiate if you opened an issue first to avoid duplicate work. -If you have any questions while doing to, please open an issue or write us an email. - -### Generative AI use - -We do not accept any contributions that were generated partly or in whole using generative AI (e.g. LLMs). -This includes but is not limited to issues, pull requests, code, documentation and artwork. +Please see [The Vegan Bug Bakery 🐛 Contribution Guidelines](https://github.com/bugbakery/bugbakery/blob/main/CONTRIBUTING.md). diff --git a/README.md b/README.md index 5e64c15f..a9983da6 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,13 @@ You can download the newest version for Windows, Linux and macOS [here](https://github.com/bugbakery/audapolis/releases/latest). If you find any bugs or UX inconveniences, we would be happy for you to [report them to us](https://github.com/bugbakery/audapolis/issues/new). +## Contributing + +If you want to contribute, please first read our + +* [Code Of Conduct](https://github.com/bugbakery/bugbakery/blob/main/CODE_OF_CONDUCT.md) and +* [Contributing Guidelines](https://github.com/bugbakery/bugbakery/blob/main/CONTRIBUTING.md) + ## Survey It would be really nice if you could help us out by answering [our short survey](https://docs.google.com/forms/d/e/1FAIpQLSerdLMYw3C3sfCyliGTal_CfeH5_jw4l2Zv-NmYc8GEabpHnA/viewform) about your needs & expectations so that we can build actually usefull software and know what you need.