Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.08 KB

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:

# 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.