Skip to content

Commit

Permalink
Merge pull request #34 from J-B-Mugundh/main
Browse files Browse the repository at this point in the history
Improved contribution guidelines
  • Loading branch information
Harish-2003 authored Oct 2, 2024
2 parents 7d6c3b4 + 7bcfc87 commit 42b4f3f
Showing 1 changed file with 40 additions and 6 deletions.
46 changes: 40 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,46 @@ This repository focuses on building and implementing cryptocurrency features lik
- **Cryptocurrency Price Prediction:** A feature that predicts the prices of the latest cryptocurrencies.

### Contribution guidelines
- Switch to the gh-pages branch all the changes need to be done in the gh-pages branch
- Fork the repo of gh-pages branch
- And then clone the forked repo into ur system using the git clone command
- And then make the changes and then commit back the changes to your forked repo
- And then make a pull request addressing the issue
- We will make the commit based upon our requirments and the quality of your code or changes

1. **Switch to the gh-pages branch**: Click on the current branch name at the top of the window to open the Branch dropdown menu. Locate and click on the gh-pages branch to switch to it.

2. **Fork the Repository**:
Click on the "Fork" button at the top right of the repository page to create your own copy of the project.

3. **Clone the Forked Repository**:
- Clone your forked repository to your local machine using the following command (replace <your-username> with your GitHub username):
- ```terminal
git clone git clone https://github.com/<your-username>/blockchain.git
```
4. **Make changes:**
- Navigate to the project directory
- ```terminal
cd blockchain
```
- Make your desired changes, whether it’s fixing bugs, adding features, or improving documentation.
5. **Commit Your Changes:**
- After making your changes, add and commit them to your local repository:
- ```terminal
git add .
git commit -m "Brief description of your changes"
```
6. **Push Changes to Your Fork:**
- Push your changes back to your forked repository on GitHub:
- ```terminal
git push origin gh-pages
```
7. **Create a Pull Request:**
Go to the original repository (OpenTekHub/blockchain) on GitHub and you’ll see a notification to create a pull request. Click on "Compare & pull request" to submit your changes for review.
8. **Address Feedback:**
Be prepared to address any feedback from the maintainers regarding your pull request. We value quality contributions and may ask for revisions.
9. **Star the Repository and Follow the Organization:**
Don’t forget to star ⭐ the repository and follow the [OpenTekHub](https://github.com/OpenTekHub) organization to stay updated with our projects and contributions!
## Getting Started
Expand Down

0 comments on commit 42b4f3f

Please sign in to comment.