Skip to content

Latest commit

 

History

History
73 lines (41 loc) · 2.9 KB

contribution.md

File metadata and controls

73 lines (41 loc) · 2.9 KB
Raw

How to Contribute

Submitting a Bug

If you have found a non-security-related bug in OpenASCE, please search the Issues first to check if the bug has already been reported. If not, create a new Issue to describe the bug.

Submitting a Security Issue

If you have discovered a security issue in OpenASCE, please do not disclose it publicly. Instead, contact the owner via email and provide a detailed description of the security issue.

Resolving Existing Issues

By reviewing the list of Issues in the repository, you can find problems that need to be addressed. You can try to resolve one of these issues.

Setting up the Development Environment

Please refer to the Installation Guide

Code Style Guidelines

Python

Code Style

The code style for Python should generally follow the PEP 8 standard. If you are using PyCharm as your development environment, you can use the BlackConnect plugin for code formatting.

Docstring

Use the Google style format for docstrings. If you are using PyCharm, you can configure it in Preferences -> Tools -> Python Integrated Tools -> Docstrings.

C++

Code Style

Use the Google Style for C++ code. If you are using CLion as your development environment, you can configure and format the code by following the instructions provided in this link.

Issues and Pull Requests

It is recommended to discuss any issues or concerns through issues first.

However, we welcome contributions related to functionality improvements, feature expansions, bug fixes, and other areas. Feel free to submit pull requests for such modifications.

Development Workflow

  • Switch to your development branch
  git checkout -b your-branch
  ....
  git add xxx
  git commit -m "xxx"

  • Develop your feature

  • Add unit tests To run unit tests:

  • Submit a Pull Request (PR)

  • Resolve conflicts

  git checkout your-branch
  git rebase master # make sure your local master is up to date
  • Code review

Your submitted code will need to pass a code review before it can be merged into the master branch. Please be patient as we assign relevant team members for code review. If there is no response from the assigned reviewers within 5 working days, please mention them in your PR. Code review comments will be directly posted in the relevant PR or issue. If you find the suggestions reasonable, please update your code accordingly.

  • Merge into master

After the code review is approved, we will assign another reviewer to conduct a further review. At least two reviewers need to agree on the PR before it can be merged into the main codebase. During this process, there may be some suggestions for modifications. Please be patient and make the necessary changes. Once all requirements are met, the PR will be merged into the master branch.