Skip to content

Commit

Permalink
Added the contibution file and fixes the file name (#152)
Browse files Browse the repository at this point in the history
  • Loading branch information
AelfHarsh authored Jul 26, 2024
1 parent bf39e3d commit 39de9d8
Show file tree
Hide file tree
Showing 8 changed files with 697 additions and 833 deletions.
309 changes: 150 additions & 159 deletions docs/quick-start/developers/vote-contract/index.md

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions docs/resources/contribution/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
sidebar_position: 10
title: Contribution Guide
description: contribution guide
---

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.

### Code Contribution

You can always send pull requests to the Github repository.

- Clone the [aelf repository](https://github.com/aelfproject/aelf/) from Github.
- Make the required 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.

#### 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.

#### 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.

### 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).

### Bug Report

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

### Thanks

Thanks to ABP, we follow their contribute guides
2 changes: 1 addition & 1 deletion docs/tools/chain-sdk/javascript-sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -829,7 +829,7 @@ To use aelf SDK, you need:

## About contributing

Read out [contributing guide]
Read out [contributing guide](../../../resources/contribution/index.md)

## About Version

Expand Down
Loading

0 comments on commit 39de9d8

Please sign in to comment.