Skip to content
This repository has been archived by the owner on Nov 4, 2021. It is now read-only.
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

news.singlestory.app/CONTRIBUTING.md

Go to file
 
 
Cannot retrieve contributors at this time
Contributing Standard process
39 lines (22 sloc) 1.44 KB
Raw Blame
Open in GitHub Desktop

Contributing

Single Story is deliberately simple.

If you find a bug, please feel free to submit a pull request (following the guidelines in this document).

If you have a grand idea for some new Single Story feature, please open an issue first, so we can have a chat about whether it's a good fit; I wouldn't want you to waste your time building something which I then reject.

Of course, you can always fork the project, if you'd like to take it in a different direction.

Standard process

Fork, then clone the repo:

git clone git@github.com:your-username/news.singlestory.app.git

Make sure the tests pass:

phpunit --testsuite=internal

Make your change, including tests, and make sure all the tests still pass:

phpunit --testsuite=internal

Push to your fork and submit a pull request.

At this point you're waiting on me.

I'll do my best to respond within 3 business days. I may suggest some changes, or an alternative approach, or I may just have some questions.

Here are some things that will increase the chance of me accepting your pull request:

  • Write tests.
  • Follow the existing code style (I don't have a formal style guide at present, but stick with PSR-2, and you won't go far wrong).
  • Write a good commit message.