Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 2.22 KB
Raw

How to Contribute

Your First Pull Request

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

Without Semantic Versioning

We keep the stable code in branch master. Development base on branch develop.

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. 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. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
  3. Fork the bytedance/appshark repo.
  4. In your forked repository, make your changes in a new git branch: 
    git checkout -b bugfix/security_bug develop
  5. Create your patch, including appropriate test cases.
  6. Follow our Style Guides.
  7. Push your branch to GitHub: 
    git push origin bugfix/security_bug
  8. In GitHub, send a pull request to appshark:master

Note: you must use one of optimize/feature/bugfix/doc/ci/test/refactor following a slash(/) as the branch prefix.

Contribution Prerequisites

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

Code Style Guides

See Coding conventions.