-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #242 from gitroomhq/doc-contributor-guide
doc: Add contribitors guide
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,33 @@ | ||
# 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. | ||
|
||
## 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. | ||
|
||
As a general rule; | ||
|
||
- **If a change is less than 3 lines**: You're probably safe just to submit the change without a discussion. This includes typos, dependency changes, and quick fixes, etc. | ||
- **If a change is more than 3 lines**: It's probably best to discuss the change in an issue or on discord first. This is simply because you might not be aware of the roadmap for the project, or understand the impact this change might have. We're just trying to save you time here, and importantly, avoid you being disappointed if your change isn't accepted. | ||
|
||
## How to contribute | ||
|
||
This project follows a Fork/Feature Brabch/Pull Request model. If you're not familiar with this, here's how it works: | ||
|
||
1. Fork the project to your GitHub account. | ||
2. Clone your fork to your local machine. | ||
3. Create a new branch for your changes. | ||
4. Make your changes in this new branch. | ||
5. Push your changes to your fork. | ||
6. Create a pull request from your fork to this project. | ||
7. We'll review your changes and approve or comment on them. | ||
|
||
## Setting up your development environment | ||
|
||
Documentation on how to setup a development environment is available here; https://docs.postiz.com/installation/development | ||
|
||
|