Contributing

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. 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: To chat with people Discord chat 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. 
    git clone https://github.com/YOUR_USERNAME/postiz.git
  3. Create a new branch: Start a new branch for your changes 
    git checkout -b feature/your-feature-name
  4. Make your changes: Implement the changes you wish to contribute.
  5. Push your changes: Push your changes to your fork. 
    git push -u origin feature/your-feature-name
  6. Create a pull request: Create an draft pull request with the name of the feature.
  7. Test your changes: Option 1: Use the Deleoper environment 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)
  8. Mark ready for review: Mark your PR ready for review after testing and wait for it to be merged.
Developer Guide