Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 2.91 KB
Raw

Contributing to MangoPay

Bugs

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search: check if the issue has already been reported.

  2. Check if the issue has been fixed: try to reproduce it using the latest master branch in the repository.

  3. Isolate the problem: ideally create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.

<url> (a link to the reduced test case)

Screenshots of the bug. (especially if it's a visual one)

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits). File a bug report

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue to discuss it first.

Make sure to adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.). Please update any documentation that is relevant to the change you're making.

Please follow this process; it's the best way to get your work included in the project:

  1. Create a new branch based on master
  2. Once you've done your first commit on the newly created branch Open a Pull Request with a clear title and description of the changes you intend to do
  3. Every pull request will be attributed a version number following this schema: [MAJOR_VERSION_NUMBER].[MINOR_VERSION_NUMBER].[PATCH_VERSION_NUMBER]
  4. Once your pull-request is fully tested, documented, and approved by everyone working on the project you will be ask to merge it with master.

You can then make your first push to production. Enjoy :-)

Do Not

Please do not use the issue tracker for personal support requests.

Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.