diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88a3297..40ad357 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -6,9 +6,9 @@ First off, thank you for considering contributing to snuffleupagus. | |||
| 6 | 6 | ||
| 7 | If you've noticed a bug or have a question, | 7 | If you've noticed a bug or have a question, |
| 8 | look at the [faq](https://snuffleupagus.readthedocs.io/faq.html) and | 8 | look at the [faq](https://snuffleupagus.readthedocs.io/faq.html) and |
| 9 | [search the issue tracker](https://github.com/nbs-system/snuffleupagus/issues) | 9 | [search the issue tracker](https://github.com/jvoisin/snuffleupagus/issues) |
| 10 | to see if someone else has already created a ticket. If not, go ahead and | 10 | to see if someone else has already created a ticket. If not, go ahead and |
| 11 | [make one](https://github.com/nbs-system/snuffleupagus/issues/new)! | 11 | [make one](https://github.com/jvoisin/snuffleupagus/issues/new)! |
| 12 | 12 | ||
| 13 | ### 2. Fork & create a branch | 13 | ### 2. Fork & create a branch |
| 14 | 14 | ||
| @@ -28,7 +28,7 @@ Just type `make coverage` or `make debug`, the testsuite should be run | |||
| 28 | automatically. | 28 | automatically. |
| 29 | 29 | ||
| 30 | Please add tests if you're fixing a bug or adding a new feature: we do have a | 30 | Please add tests if you're fixing a bug or adding a new feature: we do have a |
| 31 | [high coverage](https://coveralls.io/github/nbs-system/snuffleupagus?branch=master) | 31 | [high coverage](https://coveralls.io/github/jvoisin/snuffleupagus?branch=master) |
| 32 | (functions, lines and branches), and intend to keep it that way. | 32 | (functions, lines and branches), and intend to keep it that way. |
| 33 | 33 | ||
| 34 | #### 3.3 Debugging failures in the test suite | 34 | #### 3.3 Debugging failures in the test suite |
| @@ -45,9 +45,9 @@ launching it, in order to run the failing test inside GDB. | |||
| 45 | ### 4. Did you find a bug? | 45 | ### 4. Did you find a bug? |
| 46 | 46 | ||
| 47 | * **Ensure the bug was not already reported** by | 47 | * **Ensure the bug was not already reported** by |
| 48 | [searching all issues](https://github.com/nbs-system/snuffleupagus/issues?q=). | 48 | [searching all issues](https://github.com/jvoisin/snuffleupagus/issues?q=). |
| 49 | * If you're unable to find an open issue addressing the problem, | 49 | * If you're unable to find an open issue addressing the problem, |
| 50 | [open a new one](https://github.com/nbs-system/snuffleupagus/issues/new). | 50 | [open a new one](https://github.com/jvoisin/snuffleupagus/issues/new). |
| 51 | Be sure to include a **title and clear description**, | 51 | Be sure to include a **title and clear description**, |
| 52 | as much relevant information as possible, and a **code sample** | 52 | as much relevant information as possible, and a **code sample** |
| 53 | or an **executable test case** demonstrating the expected behavior that is not | 53 | or an **executable test case** demonstrating the expected behavior that is not |
| @@ -67,7 +67,7 @@ At this point, you should switch back to your master branch and make sure it's | |||
| 67 | up to date with our upstream master branch: | 67 | up to date with our upstream master branch: |
| 68 | 68 | ||
| 69 | ```sh | 69 | ```sh |
| 70 | git remote add upstream git@github.com:nbs-system/snuffleupagus.git | 70 | git remote add upstream git@github.com:jvoisin/snuffleupagus.git |
| 71 | git checkout master | 71 | git checkout master |
| 72 | git pull upstream master | 72 | git pull upstream master |
| 73 | ``` | 73 | ``` |
| @@ -82,7 +82,7 @@ git push --set-upstream origin 325-kill-sql-injections | |||
| 82 | 82 | ||
| 83 | Finally, go to GitHub and [make a Pull Request](https://help.github.com/articles/creating-a-pull-request) :D | 83 | Finally, go to GitHub and [make a Pull Request](https://help.github.com/articles/creating-a-pull-request) :D |
| 84 | 84 | ||
| 85 | Travis CI will [run our test suite](https://travis-ci.org/nbs-system/snuffleupagus) | 85 | Travis CI will [run our test suite](https://travis-ci.org/jvoisin/snuffleupagus) |
| 86 | against all supported PHP versions. We care about quality, so your PR won't be | 86 | against all supported PHP versions. We care about quality, so your PR won't be |
| 87 | merged until all tests pass. It's unlikely, but it's possible that your changes | 87 | merged until all tests pass. It's unlikely, but it's possible that your changes |
| 88 | pass tests in one PHP version but fail in another. In that case, you'll have to | 88 | pass tests in one PHP version but fail in another. In that case, you'll have to |
| @@ -121,7 +121,7 @@ Maintainers need to do the following to push out a release: | |||
| 121 | 121 | ||
| 122 | 1. Make sure that all pending and mergeable pull requests are in | 122 | 1. Make sure that all pending and mergeable pull requests are in |
| 123 | 2. Close the corresponding | 123 | 2. Close the corresponding |
| 124 | [milestone](https://github.com/nbs-system/snuffleupagus/milestones) | 124 | [milestone](https://github.com/jvoisin/snuffleupagus/milestones) |
| 125 | 2. Run `valgrind` (by adding a `-m` after the `-q` in the Makefile) and check that everything is ok. | 125 | 2. Run `valgrind` (by adding a `-m` after the `-q` in the Makefile) and check that everything is ok. |
| 126 | Don't mind the python-related issues. | 126 | Don't mind the python-related issues. |
| 127 | 3. Update the `src/php_snuffleupagus.h` according to [semantic versioning](https://semver.org/) | 127 | 3. Update the `src/php_snuffleupagus.h` according to [semantic versioning](https://semver.org/) |
| @@ -132,15 +132,13 @@ Maintainers need to do the following to push out a release: | |||
| 132 | 8. Create a tag for the release: | 132 | 8. Create a tag for the release: |
| 133 | 133 | ||
| 134 | ```sh | 134 | ```sh |
| 135 | git config user.signingkey 498C46FF087EDC36E7EAF9D445414A82A9B22D78 | ||
| 136 | git config user.email security@nbs-system.com | ||
| 137 | git tag -s v$MAJOR.$MINOR.$PATCH -m "v$MAJOR.$MINOR.$PATCH" | 135 | git tag -s v$MAJOR.$MINOR.$PATCH -m "v$MAJOR.$MINOR.$PATCH" |
| 138 | git push --tags | 136 | git push --tags |
| 139 | git push origin master | 137 | git push origin master |
| 140 | ``` | 138 | ``` |
| 141 | 139 | ||
| 142 | 9. Build the debian package with `make debian` | 140 | 9. Build the debian package with `make debian` |
| 143 | 10. Create the [release on github](https://github.com/nbs-system/snuffleupagus/releases) | 141 | 10. Create the [release on github](https://github.com/jvoisin/snuffleupagus/releases) |
| 144 | 11. Add the freshly built Debian package to the release | 142 | 11. Add the freshly built Debian package to the release |
| 145 | 12. Publish a [tweet](https://twitter.com/sp_php) | 143 | 12. Publish a [tweet](https://twitter.com/sp_php) |
| 146 | 13. Do the *secret release dance* | 144 | 13. Do the *secret release dance* |
