-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add contributing guidelines (CONTRIBUTING.md) (#68)
- Loading branch information
1 parent
0eca9a4
commit ca0d499
Showing
1 changed file
with
81 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,81 @@ | ||
# ☕ Contributing to CofiBlocks | ||
|
||
Thank you for your interest in contributing to **CofiBlocks**! This document outlines the steps to get started, guidelines for contributions, and how to collaborate effectively with the team. | ||
|
||
--- | ||
|
||
## 🚀 Contribution Guideline | ||
|
||
### Getting Started | ||
- 🔍 Visit the [Issues](https://github.com/Vagabonds-Labs/cofiblocks/issues) tab to see ongoing work or feature requests | ||
- 💬 If you find an issue that interests you, comment to express your interest | ||
- 📝 For new ideas, create a detailed issue with clear descriptions | ||
|
||
### Creating New Issues | ||
- 🐛 For bugs, include steps to reproduce | ||
- ✨ For features, describe the enhancement clearly | ||
|
||
### Start Working | ||
- Once an issue is assigned to you, proceed with the technical steps described below. | ||
|
||
--- | ||
|
||
## 🛠 How To Contribute | ||
|
||
1. Fork the repository to your GitHub account first. | ||
|
||
2. Clone the repository in your local machine: | ||
```bash | ||
git clone https://github.com/YOUR_USERNAME/cofiblocks.git | ||
cd marketplace | ||
``` | ||
|
||
2. Create and switch to your branch: | ||
```bash | ||
git checkout -b feature/amazing-feature | ||
``` | ||
|
||
3. Make changes: | ||
Make your changes. Ensure your code adheres to the project's coding style and standards. | ||
|
||
4. Add and commit your changes: | ||
```bash | ||
git add . | ||
git commit -m "Add amazing feature" | ||
``` | ||
|
||
5. Push to the branch: | ||
```bash | ||
git push origin feature/amazing-feature | ||
``` | ||
|
||
6. Open a Pull Request. | ||
Once your changes are ready, submit a Pull Request for review. Ensure that: | ||
|
||
Ensure your PR has a clear title, a detailed description of the changes, and references any related issues (if applicable). | ||
|
||
All contributions go through the PR review process to maintain code quality. After review, maintainers will provide feedback or merge it into the main branch. | ||
|
||
--- | ||
|
||
## Code of Conduct | ||
|
||
We are committed to creating a welcoming and inclusive environment. Please read our [Community Guidelines](COMMUNITY_GUIDELINES.md) to ensure a positive experience for everyone involved. | ||
|
||
--- | ||
|
||
## 🌐 Community Resources | ||
|
||
Stay connected with the **CofiBlocks** community! Here are the resources where you can engage, stay informed, and collaborate with the team and other contributors: | ||
|
||
- **Twitter** | ||
Follow us on [Twitter](https://x.com/cofiblocks) | ||
|
||
- **Website** | ||
Visit our [Official Website](https://www.cofiblocks.com/) | ||
|
||
We look forward to your active participation and contributions! 🚀 | ||
|
||
|
||
|
||
|