Contributing

Vortex is an open source project, and it welcomes contributions from developers and non-developers alike. You can fix a bug, propose a feature or improve this documentation. Follow this page to report a problem, suggest an idea, send a change or reach the maintainers.

I've discovered a problem

To report a problem:

1. Search the issue queue for an existing report.
2. If there's no report yet, open a new issue there and describe what you saw.

I want to suggest a feature or an idea

Open a new issue in the same issue queue and describe your idea. The maintainers review every idea for improving Vortex, though they can't accept every suggestion.

I want to submit a change

To send a change:

1. Read the Maintenance page for the part you want to change. It shows how to develop and test the template, the installer, the tooling package and this documentation site, including the tests and fixtures your change needs.
2. Open a pull request against the drevops/vortex repository. Target main for the current major version, or 2.x for the upcoming major version. 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 closes the issue when the pull request merges into main, the default branch. After a merge into 2.x, close the linked issue by hand.

Talk to us on Slack

To discuss an idea with the maintainers, join the #vortex-project-template channel on the Drupal Slack.

Roadmap

The maintainers track planned work in a public GitHub project.

➡️ See Contributing > Roadmap