Tempest is still a work in progress. Visit our GitHub or Discord

Contributing

Welcome aboard! We're excited that you are interested in contributing to the Tempest framework. We value all contributions to the project and have assembled the following resources to help you get started. Thanks for being a contributor!

How do I...

Report an Error or Bug

To report an error or a bug, please:

  • Head over to the issue page to open an issue.
  • Provide as much context about the problem you are running into and the environment you are running Tempest in.
  • Provide the version and, if relevant, the component you are running into issues with.
  • For a shot at getting our "Perfect Storm" label, submit a PR with a failing test!

Once the issue has been opened, the Tempest team will:

  • Label the issue appropriately.
  • Assign the issue to the appropriate team member.
  • Try and get a response to you as quickly as possible.

In the event that an issue is opened, but we get no response within 30 days, the issue will be closed.

Request a Feature

Tempest is a work in progress! We recognize that some features you might benefit from or expect may be missing. If you do have a feature request, please:

  • Head over to the issue page to open an issue.
  • Provide as much detail about the feature you are looking for and how it might benefit you and others.

Once the feature request has been opened, the Tempest team will:

  • Label the issue appropriately.
  • Ask any clarifying question to help better understand the use case.
  • If the feature requested is accepted, the Tempest team will assign the "Uncharted Waters" label. A Tempest team member or a member of the community can contribute the code for this.

We welcome all contributions and greatly value your time and effort. To ensure your work aligns with Tempest's vision and avoids unnecessary effort, we aim to provide clear guidance and feedback throughout the process.

Contribute Documentation

Documentation is how users learn about the framework, and developers begin to understand how Tempest works under the hood. It's critical to everything we do! Thank you in advance for your assistance in ensuring Tempest documentation is extensive, user-friendly, and up-to-date.

We welcome contributions of any size! Feel free to submit a pull request, even if it's just fixing a typo or adding a sentence.

To contribute to Tempest's documentation, please:

  • Head over to the Tempest docs repository to fork the project.
  • Add or edit any relevant documentation in a manner consistent with the rest of the documentation.
  • Re-read what you wrote and run it through a spell checker.
  • Open a pull request with your changes.

Once a pull request has been opened, the Tempest team will:

  • Use GitHub reviews to review your pull request.
  • If necessary, ask for revisions.
  • If we decide to pass on your pull request, we will thank you for your contribution and explain our decision. We appreciate all the time contributors put into Tempest!
  • If your pull request is accepted, we will mark it as such and merge it into the project. It will be released in the next tagged version! 🎉

Contribute Code

So you want to dive into the code! We cannot wait to get your pull request! To make the most of your time, please ensure that any contributions pertain to an approved feature request or a confirmed bug. This helps us focus on the vision for Tempest and ensuring the best developer experience.

To contribute to Tempest's code, please:

  • Setup Tempest Locally
  • Make the relevant code changes.
  • Write tests that verify that your contribution works as expected.
  • Run composer qa to ensure you are adhering to our style guidelines.
  • Document your changes in the CHANGELOG following the Keep a Changelog format.
  • Go to https://github.com/tempestphp/tempest-framework/pulls and create a pull request with your changes.
  • If your pull request is connected to an open issue, add a line in your description that says Fixes: #xxx, where #xxx is the number of the issue you're fixing.

Once a pull request has been opened, the Tempest team will:

  • Use GitHub reviews to review your pull request.
  • Ensure all CI pipelines are passing.
  • If necessary, ask for revisions.
  • If we decide to pass on your pull request, we will thank you for your contribution and explain our decision. We appreciate all the time contributors put into Tempest!
  • If your pull request is accepted, we will mark it as such and merge it into the project. It will be released in the next tagged version! 🎉

Setting up Tempest Locally

Then in your terminal run:

cd /path/to/your/clone
composer update

You're ready to get started!

Styling Decisions

Tempest uses a modified version of PSR-12. We automate the entire styling process because we know everyone is used to different standards and workflows. To see some of the rules we enforce, check out our CS-Fixer and Rector configurations.

The following outlines some other guidelines we have established for Tempest.

Final and Readonly as a default

Whenever possible, classes should be final and readonly. This practice promotes immutability and prevents inadvertent changes to logic.

Resources

Acronym Casing

Tempest uses a modified version of the .NET best practices for acronym casing. Please see below for our guidelines:

Do capitalize all characters of two to three character acronyms, except the first word of a camel-cased identifier. A class named IPAddress is an example of a short acronym (IP) used as the first word of a Pascal-cased identifier. A parameter named ipAddress is an example of a short acronym (ip) used as the first word of a camel-cased identifier.

Do capitalize only the first character of acronyms with four or more characters, except the first word of a camel-cased identifier. A class named UuidGenerator is an example of a long acronym (Uuid) used as the first word of a Pascal-cased identifier. A parameter named uuidGenerator is an example of a long acronym (uuid) used as the first word of a camel-cased identifier.

Do not capitalize any of the characters of any acronyms, whatever their length, at the beginning of a camel-cased identifier. A class named Uuid is an example of a long acronym (Uuid) used as the first word of a camel-cased identifier. A parameter named dbUsername is an example of a short acronym (db) used as the first word of a camel-cased identifier.

Validation Class Formatting

  1. Use of final and readonly: Ensure that validation rules are declared as final and readonly whenever possible. This practice promotes immutability and prevents inadvertent changes to the validation logic.
  2. Error Message Formatting:
    • Avoid Ending Punctuation: When crafting error messages for validation rules, refrain from including ending punctuation such as periods, exclamation marks, or question marks. This helps in maintaining a uniform style and prevents inconsistency in error message presentation.

✅ Good Example

Value should be a valid email address

❌ Bad Example

Value should be a valid email address!

Release Workflow

Tempest uses sub-splits to allow components to be installed as individual packages. The following outlines how this process works.

Workflow Steps

  1. Trigger Event

    • When a pull request is merged, or a new tag is created, the .github/workflows/subsplit-packages.yml action is run.

  2. Package Information Retrieval

    • When the subsplit-packages.yml is run, it calls bin/get-packages.
    • This PHP script uses a combination of Composer and the filesystem to return (in JSON) some information about every package. It returns the:
      • Directory
      • Name
      • Package
      • Organization
      • Repository

  3. Action Matrix Creation

    • The result of the get-packages command is then used to create an action matrix.
    • This ensures that the next steps are performed for every package discovered.

  4. Monorepo Split Action

    • The symplify/monorepo-split-github-action@v2.3.0 GitHub action is called for every package and provided the necessary information (destination repo, directory, etc.).
    • This action takes any changes and pushes them to the sub-split repository determined by combining the "Organization" and "Repository" values returned in step 2.
    • Depending on whether a tag is found or not, a tag is also supplied so the repository is tagged appropriately.

Commit and merge conventions

Commits must all respect the conventional commit specification, so the changelog and release notes are generated using the commit history.

Commit descriptions

Commit descriptions should not start with an uppercase letter and should use imperative mood:

-  feat(support): Adds some cool feature
+  feat(support): add some cool feature

Commit scopes

Scopes are not mandatory, but are highly recommended for consistency and easy of read. The following scopes are the most commonly used:

  • feat — for a new feature
  • fix — for a bug fix
  • refactor — for changes in code that are neither bug fixes or new features
  • docs — for any change related to the documentation
  • perf — for code refactoring that improves performance
  • test — for code related to automatic testing
  • style — for refactoring related to the code style (not for CSS)
  • ci — for changes related to our continuous integration pipeline
  • chore — for anything else

Here are some commit examples:

feat(support): add `StringHelper` class
feat(support/string): add `uuid` method
perf(discovery): improve cache efficiency
refactor(highlight): improve code readability
docs: mention new `highlight` package
chore: update dependencies
style: apply php-cs-fixer

Pull requests

Pull request titles and descriptions should be as explicit as possible to ease the review process.

Contributors are not required to respect conventional commits within pull requests, but doing so will ease the review process by removing some overhead for core contributors.

All pull requests will be renamed to the conventional commit convention if necessary before being squash-merged to keep the commit history and changelog clean.

GitHub • Discord
Next: Framework Bootstrap