-
Notifications
You must be signed in to change notification settings - Fork 53
Add Contributing Page #93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
*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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Module Import Issue: File Not Found
The import statement
is causing a webpack error ("Module not found: Can't resolve '../../components/snippets/earlydoc.mdx'"). Please verify whether the file exists at the given path or update/remove this import if it is not needed.