Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions pages/contributing.mdx
Original file line number Diff line number Diff line change
@@ -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)
(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.
3 changes: 1 addition & 2 deletions pages/developer-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.