Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (50 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 3.93 KB

Contributing to eXperDB-Management

Thanks for considering contribution to eXperDB-Management. You can git clone the eXperDB-Management source on the following address and send PR with your patch. But, before doing that, I recommend you to read this to follow the conventions.

https://github.com/experdb/eXperDB-Management

How to Contribute

  1. Read this contributing document.
  2. Submit an issue with proper labeling.
  3. Please wait until the label changes to contribution welcome - otherwise, it is not ready to be worked on.
  4. After the label changed to contribution welcome, you can start working on the implementation. To avoid any duplicate efforts, it is recommended to update the issue so that other developers see someone working on the issue.
  5. Before making a PR, please make sure you fully tested the code. It is highly recommended to provide the test code as well. After submitting the PR, wait for code review and approval. The reviewer may ask you for additional commits or changes.
  6. Once the change has been approved, the PR is merged by the project moderator.
  7. After merging the PR, we close the pull request. You can then delete the now obsolete branch.

Branches

contribution branch is develop master branch for release

Types of Contribution

There are various ways to contribute and participate. Please read the guidelines below regarding the process of each type of contribution.

Issues and Bugs

If you find a bug or other issues in eXperDB-Management, please submit an issue. Before submitting an issue, please invest some extra time to figure out that:

  • The issue is not a duplicate issue.
  • The issue has not been fixed in the latest release of eXperDB-Management.

When you report a bug, please make sure that your report has the following information.

  • Steps to reproduce the issue.
  • A clear and complete description of the issue.
  • Code and/or screen captures are highly recommended.

After confirming your report meets the above criteria, submit the issue. Please use labels to categorize your issue.

Feature Requests

You can also use the issue tracker to request a new feature or enhancement. Note that any code contribution without an issue link will not be accepted. Please submit an issue explaining your proposal first so that experdb community can fully understand and discuss the idea. Please use labels for your feature request as well.

Usage of Labels

You can use the following labels:

Labels for initial issue categories:

  • issue/bug: Issues with the code-level bugs.
  • issue/documentation: Issues with the documentation.
  • issue/enhancement: Issues for enhancement requests.

Status of open issues (will be tagged by the project moderators):

  • (no label): The default status.
  • open/need more information : The issue's creator needs to provide additional information to review.
  • open/reviewing: The issue is under review.
  • open/re-label needed: The label needs to be changed to confirmed as being a bug or future enhancement.
  • open/approved: The issue is confirmed as being a bug to be fixed or enhancement to be developed.
  • open/contribution welcome: The fix or enhancement is approved and you are invited to contribute to it.

Code Contribution

Please follow the coding style and quality requirements to satisfy the product standards. You must follow the coding style as best as you can when submitting code. Take note of naming conventions, separation of concerns, and formatting rules.

For the coding style of Java, please refer to the following websites: