Contributing

Vortex is an open source project, and it welcomes contributions of every kind, whether you write code or not. You can fix a bug, propose a feature, or improve the documentation you're reading right now. This page shows where to report a problem, suggest an idea, or send a change, and how to reach the maintainers.

I've discovered a problem

To report a problem, follow these steps:

1. Search the issue queue to check whether someone has already reported it.
2. If nobody has, open a new issue there and describe what you saw.

I want to suggest a feature or an idea

Suggest it as a new issue in the same issue queue. The maintainers read and review every idea for improving Vortex, though they can't accept every suggestion.

I want to submit a change

To send a change, follow these steps:

1. Read the Maintenance section for the part you want to change. It explains how to develop and test the template, the installer, the tooling package, and this documentation site, so your change arrives with the right tests and fixtures.
2. Open a pull request against the drevops/vortex repository. Target main for the current major version, or 2.x for work on the upcoming one. See Release > Branch strategy.
3. If the change resolves an issue, add the issue number to the Closes # line of the pull request template. GitHub then closes the issue when the pull request merges into main, the default branch. A pull request into 2.x leaves the issue open, so close it by hand after the merge.

Talk to us on Slack

You can also talk to the maintainers about your idea in the #vortex-project-template channel of the Drupal Slack.

Roadmap

The maintainers keep the project's roadmap in the open, in a GitHub project.

➡️ See Contributing > Roadmap