Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 2.47 KB

Contributing

The SimplePie Core Team welcomes everyone interested in the project. Members of the community can greatly help SimplePie by filing and screening bugs, aiding in code review, participating in open conversations, and of course by contributing code.

Getting Started

It is highly recommended that you become familiar with using SimplePie in your own projects before contributing directly to the code itself. We put together handy Getting Started guides with step-by-step instructions to get you up and running.

Proposing New Features

New features or directions for SimplePie can come from anyone with a good idea. Open discussion and iteration over the ideas in a public forum is essential to reaching the best possible solutions.

Things that are broader changes which impact a larger set of projects or the community at-large should be proposed as a SimplePie Enhancement Proposal (SPEP). Information about proposing a new SPEP RFC can be found at simplepie/rfc.

Contributing Code

SimplePie's website exists primarily to welcome contributions from the community. In the simplest cases, one-off patches are welcome from everyone. However, regular contributors are expected to adopt processes that help create a culture of quality within the project.

We ask that contributors first read through the content in the Contributing section of this site. This content includes detailed instructions on the process to follow when contributing a patch, including creating a pull request to get your code into the main SimplePie code base.

Bugs for the various SimplePie projects are managed in the issue trackers of their respective repositories. Anyone can file bugs, or view them to find where they can help, or to see if a bug they found is already filed.

Workflow

Here's the (simple) process for contributing code:

  1. Fork Sample to your GitHub account.
  2. Clone your GitHub copy of the repository into your local workspace.
  3. Write code, fix bugs, and add tests with 100% code coverage.
  4. Commit your changes to your local workspace and push them up to your GitHub copy.
  5. You submit a GitHub pull request with a description of what the change is.
  6. The contribution is reviewed. Maybe there will be some banter back-and-forth in the comments.
  7. If all goes well, your pull request will be accepted and your changes are merged in.

If you are looking for a prescribed workflow, please review SPEP-2.