From f4e3aef32e7735b7d6ae3c8af7fed68ccb89cd8f Mon Sep 17 00:00:00 2001 From: blek Date: Thu, 7 Dec 2023 20:19:57 +1000 Subject: [PATCH 1/2] add contributing guide --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7d03fb1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing to blek! File +blek! File is a project that aims for high quality standarts, +which means that contributions will be reviewed accordingly. +This doesnt mean that you shouldn't contribute if you have low skills; +it means that you should be ready to expect to make changes in your code as it is reviewed. + +## Argument rules +The BDFL of the project is: `blek! `. BDFL's role is to make a final call in case if an argument gets stalled or too controversial. + +Based criticism and analysis is the only things that matter within an argument inside this project. Basic your argument on personal emotions against another person will not be tolerated. + +## Expected workflow +The expected workflow is: +1. Fork +2. Commit changes +3. Open a PR +4. Merge -- 2.40.1 From aae05764f5a8aad4790ebd9776face1b00f74589 Mon Sep 17 00:00:00 2001 From: blek Date: Thu, 7 Dec 2023 20:20:42 +1000 Subject: [PATCH 2/2] mention the contributing guide in readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index ec782da..62bc9bb 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,9 @@ To qualify, your instance must be having: 3. Come up with a unique name 4. Have a public administrator email +## Contributing +Contributing guide is available [here](./CONTRIBUTING.md) (the CONTRIBUTING.md file). + ## Licensing This software is released under GPL3 license, a copyleft license that protects users' freedom by ensuring that all future copies of this software are open source as well. -- 2.40.1