Skip to content

Commit

Permalink
Add a contributing section in the readme to attract more pull requests.
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasprag committed May 13, 2016
1 parent 25ae8fe commit ad2a0e0
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
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.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,10 @@ The views for these templates are stored in `app/views/default/pages`.

You can define custom pages for your theme that will be generated when bootstrapping your website. You can define whether or not they're deletable. By default Spina creates a custom page named Homepage which is not deletable.

# Contributing

Check our [Contributing Guide](CONTRIBUTING.md) for instructions on how to help the project.

# License

Spina is released under the [MIT license](LICENSE.md).
Expand Down

0 comments on commit ad2a0e0

Please sign in to comment.