Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (52 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

67 lines (52 loc) · 3.9 KB

How to Contribute

Your First Pull Request

We use github for our codebase. You can start by reading How To Pull Request.

Branch Organization

We use git-flow as our branch organization, as known as FDD

Bugs

1. How to Find Known Issues

We are using Github Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.

2. Reporting New Issues

It is recommended that you keep the title concise yet clear. In the main body, you should elaborate on the issue you discovered, including the BMF version you are using (e.g., v0.0.12) and the complete code required to reproduce the issue. If you can also provide your thoughts on the issue's root cause, that would be even better.

3. Security Bugs

Please do not report the safe disclosure of bugs to public issues. Contact us by Support Email

How to Get in Touch

Submit a Pull Request

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.

  2. Please submit an issue instead of PR if you have a better suggestion for format tools. We won't accept a lot of file changes directly without issue statement and assignment.

  3. Be sure that the issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Before we accepting your work, we need to conduct some checks and evaluations. So, It will be better if you can discuss the design with us.

  4. Fork the BabitMF/bmf repo.

  5. In your forked repository, make your changes in a new git branch:

    git checkout -b my-fix-branch develop

  6. Create your patch. See our Patch Guidelines for details

  7. Push your branch to GitHub:

    git push origin my-fix-branch

  8. In GitHub, send a pull request to bmf:master with a clear and unambiguous title.

  9. Typically, we review your patch within a week after submission. If the patch involves significant changes, it may take more time. Therefore, if you haven't received any response after a week, please initiate a request for review.

Contribution Prerequisites

  • You are familiar with Github
  • Maybe you need familiar with Actions(our default workflow tool).

Patch Guidelines

  • If you add some code inside the framework, please include appropriate test cases
  • Commit your changes using a descriptive commit message that follows AngularJS Git Commit Message Conventions.
  • Do not commit unrelated changes together.
  • Cosmetic changes should be kept in separate patches.
  • Follow our Style Guides.

Code Style Guides

  • See C++ Code clang-format. After clang-format installed(version 16.0.6, can be installed by: pip install clang-format==16.0.6), using command: 
    clang-format -sort-includes=false -style="{BasedOnStyle: llvm, IndentWidth: 4}" -i <your file>
  • Python source code, here use: 
    pip install yapf==0.40.1
yapf --in-place --recursive --style="{indent_width: 4}"