-
-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create CONTRIBUTING.md issue no #62 Resolved
- Loading branch information
1 parent
cc1ffb3
commit b6b608f
Showing
1 changed file
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
<h1 align="center">Contributors Guide for blockchain⚡</h1> | ||
<h3 align="center">Welcome to blockchain! Make sure to star this repository😍<br>We appreciate your interest in contributing.😊 <br>This guide will help you get started with the project and make your first contribution.</h3> | ||
|
||
--- | ||
|
||
|
||
## Creating Your First Pull Request 🌟 | ||
## 1. Star this repository: Show some love by starring the repository! | ||
## 2. Fork this repository: Click the 'Fork' button at the top right of this page to create a copy of this repository in your account. | ||
## 3. Clone the forked repository: | ||
|
||
```bash | ||
git clone https://github.com/<your-github-username>/blockchain.git | ||
``` | ||
|
||
## 4. Navigate to the project directory | ||
|
||
```bash | ||
cd blockchain | ||
``` | ||
|
||
## 6. Create a new branch (use descriptive branch names | ||
feature/<feature_name> or fix/<issue_name>): | ||
```bash | ||
git checkout -b feature/<your_branch_name> | ||
``` | ||
|
||
## 7. Stage your changes and commit (use descriptive commit messages like | ||
feat: added new feature or fix: corrected issue): | ||
```bash | ||
git add . | ||
git commit -m "feat: added new feature" | ||
``` | ||
|
||
## 8. Push your local commits to the remote repository: | ||
```bash | ||
## git push -u origin feature/<your_branch_name> | ||
``` | ||
|
||
## 9. Create a Pull Request (PR): | ||
Provide a detailed description of the changes you've made. | ||
If it's a UI change, consider adding screenshots for better understanding. | ||
## 10. Congratulations! 🎉 You've made your contribution. | ||
|
||
## Pull Request Review Criteria 🧲 | ||
|
||
1. Please fill out the PR template properly when creating a pull request. | ||
2. Assign yourself to the issue you’re working on to help us track progress. | ||
3. Never commit to the main branch. | ||
4. Your work must be original and adhere to the project's coding standards. | ||
5. Comment your code where necessary for clarity. | ||
6. Always ensure all tests pass before pushing your changes. | ||
|
||
|
||
## Communication and Support 💬 | ||
1. Join the project's communication channels to interact with other contributors and seek assistance. | ||
2. If you have any questions or need help, don't hesitate to ask in the project's communication channels or comment on the relevant issue. | ||
|
||
## Code of Conduct 😇 | ||
Please follow our project's code of conduct while contributing. Treat all contributors and users with respect, and create a positive and inclusive environment for everyone. | ||
|
||
## License 📄 | ||
The project is licensed under MIT. Make sure to review and comply with the license terms. |