Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 3.95 KB

how-to-contribute.md

File metadata and controls

61 lines (36 loc) · 3.95 KB
Raw

How to contribute - Vanus

We welcome everyone to contribute to Vanus, whether you are new or experienced. Our project mainly includes two repositories: Vanus core and Vance. Vanus core is the core of the entire system, which mainly implements event subscription/publishing, event processing, and triggering serverless workloads. Vanus is mainly developed in golang language, and golang developers are welcome to contribute to Vanus.

For developers of other languages, Vance is a good choice also. Vance includes many connectors through which you can get events from almost any system and deliver events to wherever you want. Details can be obtained from Vance here. A rich connector ecosystem is critical to providing Vanus' competitiveness. We encourage developers of any language, such as java, golang, c++, and python, to contribute connectors to the Vance project.

Contributions you can make to Vanus.

Certainly, code isn't the only way to contribute to a project. We take documentation very seriously and welcome improvements to it.

  • Improve existing functionality
  • Submit a new feature
  • Contribute test cases
  • Write technical documentation
  • Translate technical documentation
  • Write technical blog

Getting started

Anyone can open an issue about documentation, or contribute a change with a pull request (PR) to the Vanus GitHub repository. Contributions to Vanus are expected to adhere to our Code of Conduct. For more instruction on setting up your development environment, see Quick Start.

Make your FIRST contribution

As your first-ever contribution, you can start with the roadmap shown below.

first-issue

  1. The first contribution can start from Creating an issue. When you notice an issue, you can submit a New Issue. Or you can submit an issue when you have a suggestion.

  2. Contributions can be submitted as PR. If you're less experienced with git workflows, Open a Pull Request would be rather helpful. Find an issue to contribute helps us quickly find an issue and start contributing.

  1. Review [Pull Requests] (https://github.com/linkall-labs/vanus/pulls) from other Vanus community members.

The general process after PR is introduced:

  • Automation suggests reviewers and approvers for PR
  • Humans review PR
  • Humans approve PR
  • Automation merges PR when all of the following are verified

Talk to us

There are three ways you can talk with our community about development-related topics:

  • Join us on Slack for a live and instant discussion with the developers of Vanus.

  • Join and post to our Mailing List for questions or suggestions that require more lengthy descriptions and context.

  • Participate in our Github Discussion, which is a collaborative communication forum of Vanus.