forked from SpinaCMS/Spina
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a contributing section in the readme to attract more pull requests.
- Loading branch information
Showing
2 changed files
with
46 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,42 @@ | ||
# Contributing to Spina | ||
|
||
First of all, you're awesome! Thanks for taking the time to contribute to `Spina`. | ||
|
||
There's a bunch of ways to help, and we welcome any and all of them: | ||
|
||
1. Opening issues | ||
2. Commenting on open issues | ||
3. Sending PRs | ||
4. Testing PRs | ||
5. Writing tests | ||
6. Writing documentation | ||
|
||
We always welcome code contributions, be it fixing an issue or adding new features. | ||
|
||
The general workflow follows these steps: | ||
|
||
- Open an issue / Find an issue / Suggest a feature via our GitHub Issues page | ||
- Discuss the issue/feature with our team of developers and community members | ||
- Take ownership of the issue/feature | ||
- Fork the project | ||
- Create a feature branch and begin work | ||
- Sync your work with the main branch from time to time | ||
- Open PR and iterate | ||
- Accepted and Merged! | ||
|
||
In shell commands, that will look something like: | ||
|
||
```sh | ||
# Fork the repository | ||
$ git clone https://github.com/your_username/Spina.git | ||
$ cd Spina | ||
$ git checkout -b feature/feature_name | ||
# Code | ||
# Run tests | ||
$ git add . | ||
$ git commit -m "Adding posts support." | ||
$ git push | ||
# Open PR from your feature branch to master | ||
``` | ||
|
||
Thank you. |
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