Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 2.92 KB
Raw

Contributing to the OXID eSales GraphQL Base Module

First off: Thank you for taking the time to contribute! 🥳👍

Contributor License Agreement

When contributing code for the first time, you must sign our Contributor License Agreement. No need to do something now, CLA Assistant will contact you after opening your first pull request. You can find more information about it on the OXID Contribution and Contributor Agreement FAQ.

How Can I Contribute?

Reporting Bugs

So, you stumbled upon a 🐛, those are tracked as GitHub Issues. Create an issue and provide all necessary information by explaining the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem
  • Describe the exact steps which reproduce the problem in as many details as possible
  • Describe the behavior you observed
  • Explain which behavior you expected to see instead and why
  • State the shop and module version you used while having the problem

Suggesting Enhancements

📈 Enhancement suggestions are tracked as GitHub Issues. Create an issue and provide all necessary information to help maintainers:

  • Use a clear and descriptive title for the issue to identify the suggestion
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful
  • State if you are willing to provide a pull request for the enhancement

Pull Requests

The basic workflow and the only way of contributing code to the project is via GitHub Pull Requests.

  • Fork the project to your account
  • Make your bug fix or enhancement
  • Add tests for your new code
  • Send the Pull Request
  • Make sure CI is 💚

We recommend you to create a topic branch to work on, this will come in handy when making multiple contributions or when you need to rebase you pull request onto another branch. Also we would like to encourage you to open up an issue before making your pull request.

What branch to send a Pull Request to?

  • Backwards compatibility breaks must go to the master branch
  • New Features go to the latest major version branch
  • Bugfixes to the latest minor version branch

If in doubt, open up an issue before writing code, so we can help you settle this and possible other questions.

I Need Help!

When you need technical help on Git and GitHub, the GitHub Help Page has you covered. You may additionally find other sources with good practices.