Skip to content

Latest commit

 

History

History
145 lines (106 loc) · 5.54 KB

CONTRIBUTING.md

File metadata and controls

145 lines (106 loc) · 5.54 KB
Raw

Contributing

First off, thank you for considering contributing to snuffleupagus.

1. Where do I go from here?

If you've noticed a bug or have a question, look at the faq and search the issue tracker to see if someone else has already created a ticket. If not, go ahead and make one!

2. Fork & create a branch

If this is something you think you can fix, then fork snuffleupagus and create a branch with a descriptive name.

A good branch name would be (where issue #325 is the ticket you're working on):

git checkout -b 325-kill-sql-injections

3. Get the test suite running

Just type make coverage or make debug, the testsuite should be run automatically.

Please add tests if you're fixing a bug or adding a new feature: we do have a high coverage (functions, lines and branches), and intend to keep it that way.

3.3 Debugging failures in the test suite

If your changes have introduced run-time failures in the test-suite, you can easily troubleshoot them by inspecting the files that php has generated for this purpose.

A nice trick is to edit the .sh file to prepend gdb --args to it before launching it, in order to run the failing test inside GDB.

4. Did you find a bug?

  • Ensure the bug was not already reported by searching all issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

5. Get the style right

Your patch should follow the same conventions & pass the same code quality checks as the rest of the project. We're using clang-format to ensure a consistent code-style. Please run it with clang-format --style="{BasedOnStyle: google, SortIncludes: false}" before committing, or even better, use a pre-commit hook.

6. Make a Pull Request

At this point, you should switch back to your master branch and make sure it's up to date with our upstream master branch:

git remote add upstream git@github.com:jvoisin/snuffleupagus.git
git checkout master
git pull upstream master

Then update your feature branch from your local copy of master, and push it!

git checkout 325-kill-sql-injections
git rebase master
git push --set-upstream origin 325-kill-sql-injections

Finally, go to GitHub and make a Pull Request :D

Travis CI will run our test suite against all supported PHP versions. We care about quality, so your PR won't be merged until all tests pass. It's unlikely, but it's possible that your changes pass tests in one PHP version but fail in another. In that case, you'll have to setup your development environment to use the problematic PHP version, and investigate what's going on!

7. Keeping your Pull Request updated

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

To learn more about rebasing in Git, there are a lot of good resources but here's the suggested workflow:

git checkout 325-kill-sql-injections
git pull --rebase upstream master
git push --force-with-lease 325-kill-sql-injections

8. Merging a PR (maintainers only)

A PR can only be merged into master by a maintainer if:

  1. It is passing CI.
  2. It has been approved by at least one maintainer. If it was a maintainer who opened the PR, only one extra approval is needed.
  3. It has no requested changes.
  4. It is up to date with current master.

Any maintainer is allowed to merge a PR if all of these conditions are met.

9. Shipping a release (maintainers only)

Maintainers need to do the following to push out a release:

  1. Make sure that all pending and mergeable pull requests are in
  2. Close the corresponding milestone
  3. Run valgrind (by adding a -m after the -q in the Makefile) and check that everything is ok. Don't mind the python-related issues.
  4. Run cd src; phpize; ./configure --enable-snuffleupagus --enable-debug; scan-build make and fix the possible issues.
  5. Update the src/php_snuffleupagus.h according to semantic versioning
  6. Update the changelog page in the documentation
  7. Update the Debian changelog in ./debian/changelog with cd debian; dch
  8. Commit the result
  9. Clean up the folder make clean; git clean -xdf
  10. Create a tag for the release:
git tag -s v$MAJOR.$MINOR.$PATCH -m "v$MAJOR.$MINOR.$PATCH"
git push --tags
  git push origin master
  1. Wait for the CI on the new tag branch to finish
  2. Create the release on github
  3. Add the freshly built Debian packages from the CI to the release
  4. Do the secret release dance