From 423ac3857300dcecfc444c6b37f11bce3c889fb5 Mon Sep 17 00:00:00 2001 From: jamesread Date: Mon, 16 Sep 2024 22:21:59 +0100 Subject: [PATCH 1/2] doc: Add contribitors guide --- CONTRIBUTING.adoc | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.adoc diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 00000000..be4a1fa5 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,33 @@ +# Contributing + +Contributions are welcome - code, docs, whatever it might be! If this is your first contribution to an Open Source project or you're a core maintainer of multiple projects, your time and interest in contributing to this project is most welcome. + +## Write code with others + +This is an open source project, with an open and welcoming community that is always keen to welcome new contributors. We recommend the two best ways to interact with the community are: + +- **GitHub issues**: To discuss more slowly, or longer-written messages. +- **[Discord chat](https://discord.postiz.com)**: To chat with people [Discord chat](https://discord.postiz.com/) and a quicker feedback. + +As a general rule; + +- **If a change is less than 3 lines**: You're probably safe just to submit the change without a discussion. This includes typos, dependency changes, and quick fixes, etc. +- **If a change is more than 3 lines**: It's probably best to discuss the change in an issue or on discord first. This is simply because you might not be aware of the roadmap for the project, or understand the impact this change might have. We're just trying to save you time here, and importantly, avoid you being disappointed if your change isn't accepted. + +## How to contribute + +This project follows a Fork/Feature Brabch/Pull Request model. If you're not familiar with this, here's how it works: + +1. Fork the project to your GitHub account. +2. Clone your fork to your local machine. +3. Create a new branch for your changes. +4. Make your changes in this new branch. +5. Push your changes to your fork. +6. Create a pull request from your fork to this project. +7. We'll review your changes and approve or comment on them. + +## Setting up your development environment + +Documentation on how to setup a development environment is available here; https://docs.postiz.com/installation/development + + From 6ded2719c5602cde3af79534433f39e53104bb3d Mon Sep 17 00:00:00 2001 From: jamesread Date: Tue, 24 Sep 2024 11:47:22 +0100 Subject: [PATCH 2/2] rename .adoc to .md --- CONTRIBUTING.adoc => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTING.adoc => CONTRIBUTING.md (100%) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.adoc rename to CONTRIBUTING.md