Skip to content

Commit

Permalink
add note about package versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
joshmanders committed Sep 29, 2024
1 parent bc52b65 commit 342a982
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 +7,59 @@ We accept contributions via Pull Requests on [GitHub](https://github.com/cloudin
## Issues

### Creating an Issue

If you find a bug, problem, or maybe the documentation just doesn't make sense, please create an Issue to document the concern.

### Description

Please be descriptive in your Issue. The more info you provide, the more likely someone will be able to help.

### Code Examples

If you're experiencing an issue with the code, the most helpful thing you can do is create an example where you can reproduce the problem. This can be an open source Github repo, a private repo you can share with the maintainers, a [CodeSandbox](https://codesandbox.io/), or really anything to show the issue live with code along side of it.

## Pull Requests

The project uses **[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md)**. The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).

### Creating a Pull Request

If you're able to fix an active Issue, feel free to create a new Pull Request addressing the problem. There are no gaurantees that the code will be merged in "as is", but chances are, if you're willing to work with the maintainers, everyone will be able to come up with a solution everyone can be happy with.

Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

If you want to do more than one thing, send multiple pull requests.

### Description

Please be descriptive in your Pull Request. Whether big or small, it's important to be able to see the context of a change throughout the history of a project.

### Linking Fixed Issues

If the Pull Request is addressing an Issue, please link that issue by specifying the `Fixes [Issue #]` syntax within the Pull Request.

### Tests

Your patch won't be accepted if it doesn't have tests.

You can run tests with:
``` bash

```bash
$ composer test
```

### Documentation

Make sure the `README.md` and any other relevant documentation are kept up-to-date.

### Release Cycle

We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

### Preparing for a Release

When preparing for a new release, make sure to update the `CloudinaryEngine::PACKAGE_VERSION` constant in `src/CloudinaryEngine.php`. This ensures that the package version is correctly reflected in the code.

### Branching

Create a feature branch. Don't ask us to pull from your main branch.

0 comments on commit 342a982

Please sign in to comment.