-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from DevSwayam/main
Adding Contribution Guide Markdown file
- Loading branch information
Showing
2 changed files
with
68 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 @@ | ||
|
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,67 @@ | ||
# Project Name Contribution Guide | ||
|
||
Welcome to the contribution guide for Web3-with-The-Graph-India! We're excited that you're interested in contributing to our project. This guide will help you understand how you can contribute effectively. Please take a moment to read through this guide before getting started. | ||
|
||
## Table of Contents | ||
|
||
- [Introduction](#introduction) | ||
- [Getting Started](#getting-started) | ||
- [Contributing](#contributing) | ||
- [Issues](#issues) | ||
- [Pull Requests](#pull-requests) | ||
- [Documentation](#documentation) | ||
- [Review Process](#review-process) | ||
- [Community Guidelines](#community-guidelines) | ||
|
||
## Introduction | ||
|
||
Web3-with-The-Graph-India is an open source project that aims to [Our Aim Here]. We welcome contributions from the community and value the diversity of ideas and experiences that contributors bring. | ||
|
||
## Getting Started | ||
|
||
To get started with contributing, follow these steps: | ||
|
||
1. **Fork the repository**: Click the "Fork" button on the top right corner of this repository's page. | ||
2. **Clone your fork**: `git clone https://github.com/your-username/Web3-with-The-Graph-India.git` | ||
3. **Create a branch**: `git checkout -b your-branch-name` | ||
4. **Make changes**: Work on your changes and improvements. | ||
5. **Commit**: Commit your changes with a meaningful commit message. | ||
6. **Push**: Push your changes to your forked repository. | ||
7. **Create a Pull Request**: Submit a pull request from your branch to our main repository's `main` branch. | ||
|
||
## Contributing | ||
|
||
### Issues | ||
|
||
If you find a bug, have a feature request, or want to discuss an improvement, please open an issue on our [issue tracker](link-to-issue-tracker). Provide as much detail as possible to help us understand the problem or suggestion. | ||
|
||
### Pull Requests | ||
|
||
We welcome pull requests for bug fixes, improvements, and new features. Here's the process: | ||
|
||
1. Create a fork and branch as mentioned in the "Getting Started" section. | ||
2. Submit a pull request with a descriptive title and details about your changes. | ||
3. Your pull request will be reviewed, and feedback will be provided. | ||
4. Make any necessary changes based on the feedback. | ||
5. Once approved, your changes will be merged into the main repository. | ||
|
||
|
||
## Documentation | ||
|
||
Good documentation is essential for a successful project. If you're adding new features or making changes, update the documentation accordingly. If you're unsure where to document your changes, feel free to ask in your pull request. | ||
|
||
## Review Process | ||
|
||
All pull requests will be reviewed by our maintainers. Be prepared to address feedback and make necessary changes to your pull request. Maintainers will ensure that the code is in line with our project standards. | ||
|
||
## Community Guidelines | ||
|
||
We expect all contributors to adhere to our code of conduct and contribute in a respectful and inclusive manner. Please read our [community guidelines](link-to-community-guidelines) before getting involved. | ||
|
||
## License | ||
|
||
By contributing to Project Name, you agree that your contributions will be licensed under the [project's license](link-to-license). | ||
|
||
--- | ||
|
||
Thank you for considering contributing to Web3-with-The-Graph-India! Your efforts help make this project great. |