Contributing to Qingtian Enclave

Welcome to Qingtian Enclave! This document is a guideline about how to contribute to Qingtian Enclave.

Code of Conduct

The code of conduct is described in CODE_OF_CONDUCT.md.

Contributing

Qingtian Enclave welcomes new participants to join in this project. We are committed to building up an open and welcomed community. The following paragraph introduce how to contribute in Qingtian Enclave project.

Open an issue

If you discover potential security issues, bugfixes, or want to give improvements suggestions, you can open an issue on Github to report it.

Please note that any PR must be associated with a valid issue. Otherwise the PR will be rejected.

Begin your contribute

If you want to make contribution to our project, please create a new pull request. The develop branch is used as the unstable development branch.

Here is the workflow for contributors to create PR:

Fork to your own repository
Clone fork to local repository
Create a new branch and work on it
Keep your branch in sync
Commit your changes
Push your commits to your forked repository
Create a pull request to develop branch

There are some notes while creating a pulling request:

Please create the request to develop branch
Please ensure the PR has a corresponding issue
Please provide detailed documents about your design and usage, if your PR contains large changes.
After creating a PR, one or more reviewers will be assigned to the pull request.
Before merging a PR, squash any fix review feedback, typo, merged, and rebased sorts of commits. The final commit message should be clear and concise.