From d0cf80d23efa72272d0b1a85a0a5ce9487ed89bd Mon Sep 17 00:00:00 2001 From: egelhaus <156946629+egelhaus@users.noreply.github.com> Date: Sun, 13 Apr 2025 15:20:55 +0200 Subject: [PATCH 1/4] Add contribution guide --- pages/contributing.mdx | 63 +++++++++++++++++++++++++++++++++++++++ pages/developer-guide.mdx | 3 +- 2 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 pages/contributing.mdx diff --git a/pages/contributing.mdx b/pages/contributing.mdx new file mode 100644 index 0000000..db15308 --- /dev/null +++ b/pages/contributing.mdx @@ -0,0 +1,63 @@ +--- +title: Contributing +--- + +import EarlyDoc from "../../components/snippets/earlydoc.mdx"; + +# 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. + +## Pre-Requirements + +- GitHub Account +- Experience with PRs, Forks, Branches +- An Computer (Mac, Linux, Windows etc.) +- (Optional) Joined the discord server + +## Read the developers guide + +The documentation site has a [developer guide](https://docs.postiz.com/developer-guide). +That guide provides you a good understanding of the project structure, and how to setup your development environment. Read this document after you have read that guide. +This page is intended to provide you a good understanding of how to submit your first contribution. + +## 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. + +## Types of Contributions + +Contributions can include: +- **Code improvements:** Fixing bugs or adding new features. +- **Documentation updates:** Enhancing clarity or adding missing information. +- **Feature requests:** Suggesting new capabilities or integrations. +- **Bug reports:** Identifying and reporting issues. + +## How to contribute + +This project follows a Fork/Feature Branch/Pull Request model. If you're not familiar with this, here's how it works: + +1. **Fork the project:** Create a personal copy of the repository on your GitHub account. +2. **Clone your fork:** Bring a copy of your fork to your local machine. + ```bash + git clone https://github.com/YOUR_USERNAME/postiz.git + ``` +3. **Create a new branch**: Start a new branch for your changes + ```bash + git checkout -b feature/your-feature-name + ``` +6. **Make your changes**: Implement the changes you wish to contribute. +7. **Push your changes**: Push your changes to your fork. + ```bash + git push -u origin feature/your-feature-name + ``` +9. **Create a pull request**: Create an draft pull request with the name of the feature. +10. **Test your changes**: +*Option 1*: Use the [Deleoper environment](https://docs.postiz.com/installation/development) +*Option 2*: Wait a little, after the docker image workflow finished, you can pull it on your machine and test it. +11. **Mark ready for review**: Mark your PR ready for review after testing and wait for it to be merged. \ No newline at end of file diff --git a/pages/developer-guide.mdx b/pages/developer-guide.mdx index 12bbb20..99e5ccc 100644 --- a/pages/developer-guide.mdx +++ b/pages/developer-guide.mdx @@ -48,5 +48,4 @@ worker is built with [NestJS](https://nestjs.com/) and share components with the ## Contributors Guide -The Postiz [contributors guide](https://github.com/gitroomhq/postiz-app/blob/main/CONTRIBUTING.md) is contained in the main repository. It provides information on how to contribute to the project, mainly the format for how to submit a pull request. - +The Postiz [contributors guide](./contributing) is contained in the main repository. It provides information on how to contribute to the project, mainly the format for how to submit a pull request. \ No newline at end of file From 1c93cbad9b2cc29260ef8cd2caa933f171256f50 Mon Sep 17 00:00:00 2001 From: egelhaus <156946629+egelhaus@users.noreply.github.com> Date: Sun, 13 Apr 2025 15:22:02 +0200 Subject: [PATCH 2/4] Add docker image name --- pages/contributing.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/contributing.mdx b/pages/contributing.mdx index db15308..b594087 100644 --- a/pages/contributing.mdx +++ b/pages/contributing.mdx @@ -59,5 +59,5 @@ This project follows a Fork/Feature Branch/Pull Request model. If you're not fam 9. **Create a pull request**: Create an draft pull request with the name of the feature. 10. **Test your changes**: *Option 1*: Use the [Deleoper environment](https://docs.postiz.com/installation/development) -*Option 2*: Wait a little, after the docker image workflow finished, you can pull it on your machine and test it. +*Option 2*: Wait a little, after the docker image workflow finished, you can pull it on your machine and test it. (Image name: ghcr.io/gitroomhq/postiz-app-pr/PR_ID) 11. **Mark ready for review**: Mark your PR ready for review after testing and wait for it to be merged. \ No newline at end of file From d3b575010e1b8c41fc7524afc8b0e33c2e96aa30 Mon Sep 17 00:00:00 2001 From: egelhaus <156946629+egelhaus@users.noreply.github.com> Date: Sun, 13 Apr 2025 15:25:26 +0200 Subject: [PATCH 3/4] Fix --- pages/contributing.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/contributing.mdx b/pages/contributing.mdx index b594087..fc7962e 100644 --- a/pages/contributing.mdx +++ b/pages/contributing.mdx @@ -2,7 +2,7 @@ title: Contributing --- -import EarlyDoc from "../../components/snippets/earlydoc.mdx"; +import EarlyDoc from "../components/snippets/earlydoc.mdx"; # Contributing From c1cea294b5a0d22b0126eba0f4d79778fd909ed0 Mon Sep 17 00:00:00 2001 From: egelhaus <156946629+egelhaus@users.noreply.github.com> Date: Mon, 14 Apr 2025 18:18:26 +0200 Subject: [PATCH 4/4] disable docker --- pages/contributing.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/contributing.mdx b/pages/contributing.mdx index fc7962e..81920a8 100644 --- a/pages/contributing.mdx +++ b/pages/contributing.mdx @@ -59,5 +59,5 @@ This project follows a Fork/Feature Branch/Pull Request model. If you're not fam 9. **Create a pull request**: Create an draft pull request with the name of the feature. 10. **Test your changes**: *Option 1*: Use the [Deleoper environment](https://docs.postiz.com/installation/development) -*Option 2*: Wait a little, after the docker image workflow finished, you can pull it on your machine and test it. (Image name: ghcr.io/gitroomhq/postiz-app-pr/PR_ID) +(Currently in Developemnt) *Option 2*: Wait a little, after the docker image workflow finished, you can pull it on your machine and test it. (Image name: ghcr.io/gitroomhq/postiz-app-pr/PR_ID) 11. **Mark ready for review**: Mark your PR ready for review after testing and wait for it to be merged. \ No newline at end of file