Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 4.99 KB

CONTRIBUTING.md

File metadata and controls

83 lines (53 loc) · 4.99 KB
Raw

Contributing to the Open3CL library

You want to contribute to the Open3CL library? Welcome on board, and we will help you as much as we can.

Here are the guidelines we'd like you to follow so that we can be of more help:

Questions and help

This is the Open3CL Library bug tracker, and it is used for Issues and Bugs and for Feature Requests. It is not a help desk or a support forum.

If you have a question on using Open3CL Library, please contact us by email.

Issues and Bugs

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting a ticket to our GitHub issues. Even better, you can submit a Pull Request to our Open3CL project.

Please see the Submission Guidelines below.

Feature Requests

You can request a new feature by submitting a ticket to our GitHub issues. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first. Please open a ticket which clearly states that it is a feature request in the title and explain clearly what you want to achieve in the description, and the team will discuss with you what should be done in that ticket. You can then start working on a Pull Request.
  • Small Changes can be proposed without any discussion. Open up a ticket which clearly states that it is a feature request in the title. Explain your change in the description, and you can propose a Pull Request straight away.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and has not been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the issue - if an error is being thrown a stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • Reproduce the error - an unambiguous set of steps to reproduce the error. If you have a JavaScript error, maybe you can provide a live example with JSFiddle?
  • Related issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
  • JHipster Registry Version(s) - is it a regression?
  • Browsers and Operating System - is this a problem with all browsers or only IE8?

Click here to open a bug issue with a pre-filled template. For feature requests and enquiries you can use templates.

Issues opened without any of these info will be closed without any explanation.

Submitting a Pull Request

Before you submit your pull request consider the following guideline:

  • Search GitHub for an open or closed Pull Request that relates to your submission.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more tests.
  • All files must follow the .editorconfig file located at the root of the project. Please note that generated projects use the same .editorconfig file, so that both the generator and the generated projects share the same configuration.
  • JavaScript files must follow the eslint configuration defined at the project root, which is based on JavaScript Standard Style Guide.

Please ensure to run npm run qa:lint and npm test on the project root before submitting a pull request. You can also run npm run qa:lint:fix to fix some of the lint issues automatically.

Git Commit Guidelines

We have rules over how our git commit messages must be formatted. Please ensure to squash unnecessary commits so that your commit history is clean.

Commit Message Format

Each commit message should be compliant with commitlint convention.