Skip to content

Commit

Permalink
docs: contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
yongenaelf committed Aug 1, 2024
1 parent 221678e commit 5837de4
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/resources/contribution/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@ title: Contribution Guide
description: Contribute to aelf
---

aelf is an [open source](https://github.com/aelfproject) and community driven project. This guide is aims to help anyone wants to contribute to the project.
aelf is an [open source](https://github.com/aelfproject), community-driven project. This guide aims to assist anyone who wants to contribute.

### Code Contribution

You can always send pull requests to the Github repository.
You can send pull requests to the [aelf repository](https://github.com/aelfproject/aelf/). Steps:

- Clone the [aelf repository](https://github.com/aelfproject/aelf/) from Github.
- Make the required changes.
- Clone the repository.
- Make your changes.
- Send a pull request.

Before making any change, please discuss it on the [Github issues](https://github.com/aelfproject/aelf/issues). In this way, no other developer will work on the same issue and your PR will have a better chance to be accepted.
Discuss changes on [Github issues](https://github.com/aelfproject/aelf/issues) before starting to avoid duplicating work.

#### Bug Fixes & Enhancements

You may want to fix a known bug or work on a planned enhancement. See [the issue list](https://github.com/aelfproject/aelf/issues) on Github.
Refer to the [issue list](https://github.com/aelfproject/aelf/issues) for known bugs and enhancements.

#### Feature Requests

If you have a feature idea for the framework or modules, [create an issue](https://github.com/aelfproject/aelf/issues/new) on Github or attend to an existing discussion. Then you can implement it if it's embraced by the community.
For new feature ideas, [create an issue](https://github.com/aelfproject/aelf/issues/new) or join an existing discussion. Implement features that gain community support.

### Blog Posts & Tutorials

If you decide to create some tutorials or blog posts on aelf, please inform us (by creating a [Github issue](https://github.com/aelfproject/aelf/issues)), so we may add a link to your tutorial/post in the official documentation and we can announce it on our [Twitter account](https://twitter.com/aelfblockchain).
If you create tutorials or blog posts about aelf, inform us via a [Github issue](https://github.com/aelfproject/aelf/issues) so we can link to it in the official documentation and announce it on our [X account](https://x.com/aelfblockchain).

### Bug Report

If you find any bug, please [create an issue on the Github repository](https://github.com/aelfproject/aelf/issues/new).
Report bugs by [creating an issue](https://github.com/aelfproject/aelf/issues/new) on the Github repository.

### Thanks

Thanks to ABP, we follow their contribute guides
Thanks to ABP for their contribution guide, which has inspired this guide.

0 comments on commit 5837de4

Please sign in to comment.