|
| 1 | +--- |
| 2 | +title: Contributing |
| 3 | +--- |
| 4 | + |
| 5 | +import EarlyDoc from "../components/snippets/earlydoc.mdx"; |
| 6 | + |
| 7 | +# Contributing |
| 8 | + |
| 9 | +Contributions are welcome - code, docs, whatever it might be! |
| 10 | +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. |
| 11 | + |
| 12 | +## Pre-Requirements |
| 13 | + |
| 14 | +- GitHub Account |
| 15 | +- Experience with PRs, Forks, Branches |
| 16 | +- An Computer (Mac, Linux, Windows etc.) |
| 17 | +- (Optional) Joined the discord server |
| 18 | + |
| 19 | +## Read the developers guide |
| 20 | + |
| 21 | +The documentation site has a [developer guide](https://docs.postiz.com/developer-guide). |
| 22 | +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. |
| 23 | +This page is intended to provide you a good understanding of how to submit your first contribution. |
| 24 | + |
| 25 | +## Write code with others |
| 26 | + |
| 27 | +This is an open source project, with an open and welcoming community that is always keen to welcome new contributors. |
| 28 | +We recommend the two best ways to interact with the community are: |
| 29 | + |
| 30 | +- **GitHub issues**: To discuss more slowly, or longer-written messages. |
| 31 | +- **[Discord chat](https://discord.postiz.com)**: To chat with people [Discord chat](https://discord.postiz.com/) and a quicker feedback. |
| 32 | + |
| 33 | +## Types of Contributions |
| 34 | + |
| 35 | +Contributions can include: |
| 36 | +- **Code improvements:** Fixing bugs or adding new features. |
| 37 | +- **Documentation updates:** Enhancing clarity or adding missing information. |
| 38 | +- **Feature requests:** Suggesting new capabilities or integrations. |
| 39 | +- **Bug reports:** Identifying and reporting issues. |
| 40 | + |
| 41 | +## How to contribute |
| 42 | + |
| 43 | +This project follows a Fork/Feature Branch/Pull Request model. If you're not familiar with this, here's how it works: |
| 44 | + |
| 45 | +1. **Fork the project:** Create a personal copy of the repository on your GitHub account. |
| 46 | +2. **Clone your fork:** Bring a copy of your fork to your local machine. |
| 47 | + ```bash |
| 48 | + git clone https://github.com/YOUR_USERNAME/postiz.git |
| 49 | + ``` |
| 50 | +3. **Create a new branch**: Start a new branch for your changes |
| 51 | + ```bash |
| 52 | + git checkout -b feature/your-feature-name |
| 53 | + ``` |
| 54 | +6. **Make your changes**: Implement the changes you wish to contribute. |
| 55 | +7. **Push your changes**: Push your changes to your fork. |
| 56 | + ```bash |
| 57 | + git push -u origin feature/your-feature-name |
| 58 | + ``` |
| 59 | +9. **Create a pull request**: Create an draft pull request with the name of the feature. |
| 60 | +10. **Test your changes**: |
| 61 | +*Option 1*: Use the [Deleoper environment](https://docs.postiz.com/installation/development) |
| 62 | +(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) |
| 63 | +11. **Mark ready for review**: Mark your PR ready for review after testing and wait for it to be merged. |
0 commit comments