Skip to content

Commit 9ab7ebf

Browse files
committed
Contribution docs added.
1 parent 1d131fc commit 9ab7ebf

File tree

6 files changed

+65
-0
lines changed

6 files changed

+65
-0
lines changed

Diff for: docs/standards/contribution.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contribution Guidelines
2+
3+
Thank you for your interest in contributing to this repository! To ensure a smooth and organized collaboration, please follow these guidelines:
4+
5+
## Fork and Branch
6+
7+
1. Fork this repository to your own GitHub account.
8+
2. Clone the forked repository to your local machine.
9+
3. Create a new branch for your changes: `git checkout -b feature/your-feature-name`.
10+
11+
## Make Changes
12+
13+
1. Make your desired changes to the codebase.
14+
2. Ensure that your changes adhere to the project's naming conventions.
15+
3. Run the tests to ensure that they are still passing.
16+
17+
## Commit and Push
18+
19+
1. Commit your changes with a descriptive commit message: `git commit -m "Add feature: your feature name`.
20+
2. Push your changes to your forked repository: `git push origin feature/your-feature-name`.
21+
22+
## Submitting a Pull Request
23+
24+
1. Go to the original repository on GitHub.
25+
2. Click on the "New Pull Request" button.
26+
3. Select the `develop` branch as the base branch and your branch as the compare branch.
27+
4. Provide a clear and concise title and description for your pull request.
28+
5. Submit the pull request.
29+
30+
## Code Review and Merge
31+
32+
1. Your pull request will be reviewed by the repository maintainers.
33+
2. Address any feedback or comments provided during the review process.
34+
3. Once approved, your changes will be merged into the `develop` branch.
35+
36+
Thank you for your contribution!

Diff for: docs/standards/working-on-issues.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# How to Work on an Issue
2+
3+
This document outlines the process for working on issues in this GitHub repository. Most of the proposed issues have a reward in dollars. Here's how you can contribute:
4+
5+
## Step 1: Check the Issues
6+
7+
Go through the list of issues in the repository. Find an issue that you believe you can resolve.
8+
9+
## Step 2: Claim the Issue
10+
11+
Once you've found an issue you'd like to work on, claim it. You can do this by commenting on the issue. In your comment, specify the timeframe within which you will complete the work. For example, you might say, "I will finish this by May 7th."
12+
13+
## Step 3: Await Approval
14+
15+
After you've claimed an issue, the committee team will review your suggestion. They may approve it, reject it, or negotiate the terms.
16+
17+
## Step 4: Start Working
18+
19+
Once your claim is approved, the issue will be assigned to you. You can now start working on it.
20+
21+
## Step 5: Finish the Work
22+
23+
After you've finished the work, submit it for verification.
24+
25+
## Step 6: Receive Your Reward
26+
27+
Once your work is verified and approved, we will ask for your wallet address. The reward will then be paid to you.
28+
29+
Thank you for your interest in contributing to our project!
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)