Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (43 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 3.33 KB
Raw

Contributing to QuBA-libre

Thank you for contributing to QuBA-libre. We appreciate and are thankful for contributions in all shapes and sizes.

Asking Questions

  • Use GitHub Discussions to ask questions.
  • Do not open issues for questions. Questions submitted through GitHub issues will be closed.
  • Consult the Github Discussions to see whether your question has already been answered.
  • Avoid contacting individual contributors directly; ask questions in public instead. A well-worded question will help serve as a resource to others searching for help.

Filing Issues

Looking for existing Issues

Before you create a new issue, please do a search in open issues to see if the defect or enhancement request has already been filed.

If you find your issue already exists, add relevant comments to the existing issue.

Optionally indicate your interest by reacting with thumbs up (👍). Issues with higher community attention are more likely to be addressed sooner.

If you cannot find an existing issue for your bug or feature request, create a new issue using the guidelines below.

Requesting Enhancements

File a single issue per enhancement request. Do not list multiple enhancement requests in the same issue.

Describe your use case and the value you will get from the requested enhancement.

Reporting Defects

File a single issue per defect. Do not list multiple defects in the same issue.

The more information you can provide, the more likely we will be successful at reproducing the bug and finding a fix.

Depending on the defect, we may ask you for a sample QuBA that triggers your issue.

Before sharing Documents, screenshots or any other resources with us, please ensure that you blank, pseudonymise or remove all references that may leak internals of your organization.

Improving Documentation

Beside extending existing documentation or correcting any errors it may contain, another great way to contribute is to update the Github Discussion with questions and answers that benefit the community.

Contributing Code

Before raising pull requests, please file a defect or enhancement request first.

Pull Requests

  • Pull requests will be discussed personally beforehand. As the project uses Excel merges are not a thing.
  • New code should be consistent with the existing code style.
  • New code must not include any Visual Basic code. Only formulas are allowed.
  • Commits must be signed off to indicate agreement with Developer Certificate of Origin (DCO).
  • Optionally include visualizations like screenshots, videos or diagrams in the pull request description.

Commit Messages

Please follow these rules when writing a commit message:

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how