Contributing guide

This guide will ensure that you have all the necessary information needed to be an effective contributor to Openapi-forge

We are actively looking for contributors to help increase the Forge's capabilities and robustness

Before you create an issue

Does the issue already exist? Remember to check the open and closed tickets

What to include in the issue

Bug
- A short and clear title of the bug
- Forge version (and generator versions if it relates to the generators)
- Reproduction steps or a link to a project that shows the bug
- Expected and actual behaviour
New Feature / Improvement
- A short and clear title of the new feature / improvement
- A more detailed description of the new feature / improvement (adding code snippets if you desire)

Before you start working on an issue

Fork the repos you will need to work on. You may also need the generators
Have you contributed before? If not, look for issues with the 'good first issue' label
Is it assigned to anyone else? If so, post a message to see if the assignee is still working on it
Is it assigned to you? If not, post a message stating your intent so that the maintainers and other contributors know what is being developed
Do you understand the issue fully? If not, ask on in the issue. We are all here to help you contribute

Before you submit a PR

Provide a link to the issue that PR addresses
Link any related PRs This could happen when forge and generator needs updating
Have you added tests?
Are all workflow steps passing?
Is it ready for review? If not, create a draft