How to Contribute to BNB Greenfield Documentation
Welcome to the BNB Greenfield network, a thriving ecosystem driven by the collective power of its community. We believe that innovation knows no bounds, and we warmly welcome you to join us on our mission to shape the future of decentralized web3 economy.
Contributing to BNB Greenfield is not just about code; it's about sharing your unique expertise, ideas, and passion to enhance the platform and empower global users.
This page serves as a guide to showcase the various ways you can make a positive impact and play a crucial role in building a borderless, transparent, and inclusive travel network for all.
Following are the channels you can use for providing your valued contributions
Steps for Contributing on GitHub
- Make sure you have a GitHub account.
- Create a GitHub issue for your contribution, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce if it is a bug.
- Fork the repository on GitHub.
- Minor Changes
- For small changes to comments and documentation, it is not always necessary to create a new GitHub issue. In this case, it is appropriate to start the first line of a commit with 'doc' instead of an issue number.
Finding things to work on
The first place to start is always looking over the current GitHub issues for the project you are interested in contributing to. Issues marked with
help wanted are usually pretty self-contained and a good place to get started.
Of course, feel free to create a new issue if you think something needs to be added or fixed.
- Create a topic branch from where you want to base your work. This is usually the master branch. Please avoid working directly on the master branch.
- Make sure you have added the necessary tests for your changes and make sure all tests pass.
- Submit a pull request to the docs repository in the BNB Chain organization.
- Include a descriptive
- Changes contributed via pull request should focus on a single issue at a time.
- Rebase your local changes against the master branch. Resolve any conflicts that arise.
- Greenfield-Blockchain: official Golang implementation of the Greenfield Blockchain.
- Greenfield-Cosmos-sdk a cosmos-sdk fork for greenfield.
- Greenfield-Tendermint: the consensus layer of Greenfield blockchain.
- Greenfield-Contract: the cross chain contract for Greenfield that deployed on BSC network.
- Greenfield-Relayer: the service that relay cross chain package to both chains.
- Greenfield-Storage-Provider: the storage service infrastructures provided by either organizations or individuals.
- Greenfield-Cmd: the most powerful command line to interact with Greenfield system.
- Greenfield-Common: a common library for different repos of greenfield.