Skip to content
This repository has been archived by the owner on Feb 7, 2025. It is now read-only.

docs: update CONTRIBUTING.md with GitHub Discussions section and visual enhancements #435

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update CONTRIBUTING.md with GitHub Discussions section and visual enhancements #435

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26a05d3
Update CONTRIBUTING.md
lovezan Feb 6, 2025
5805243
Update CONTRIBUTING.md
lovezan Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,54 @@
# Accord Project Web Components Contribution Guide
# 🚀 Accord Project Web Components Contribution Guide

Welcome to the **Accord Project Web Components** contribution guide! We're thrilled that you're interested in contributing to this project. This guide will help you get started and make your contribution process smooth and enjoyable.

---

## 📊 Repository Stats

| Badge | Description |
|-------|-------------|
| ![GitHub Issues](https://img.shields.io/github/issues/accordproject/web-components?label=Open%20Issues&color=blue) | Number of open issues |
| ![GitHub Pull Requests](https://img.shields.io/github/issues-pr/accordproject/web-components?label=Open%20PRs&color=green) | Number of open pull requests |
| ![GitHub Last Commit](https://img.shields.io/github/last-commit/accordproject/web-components?label=Last%20Commit&color=orange) | Date of the last commit |

---

## ❗ Accord Project Contribution Guide ❗

We'd love for you to contribute to our source code and to make Accord Project Web Component technology even better than it is today! Please refer to the [Accord Project Contribution guidelines][apcontribute] we'd like you to follow.

[apcontribute]: https://github.com/accordproject/techdocs/blob/master/CONTRIBUTING.md
[apcontribute]: https://github.com/accordproject/techdocs/blob/master/CONTRIBUTING.md

---

## 💬 Using GitHub Discussions

We encourage all contributors to use [GitHub Discussions](https://github.com/accordproject/web-components/discussions) as the primary platform for:

- **Asking questions**: If you're unsure about how to contribute, need clarification on an issue, or have general questions, start a discussion.
- **Sharing ideas**: Propose new ideas, improvements, or feature requests in the Discussions section.
- **Getting help**: If you're stuck or need guidance, the community and maintainers are here to assist you.

### 🎯 Why Use GitHub Discussions?
- **Keeps issues focused**: By using Discussions for questions and ideas, we can keep the Issues section dedicated to bugs and actionable tasks.
- **Encourages collaboration**: Discussions are a great place to brainstorm, share knowledge, and engage with the community.
- **Improves onboarding**: New contributors can easily find answers to common questions and get involved in the project.

### 🚀 How to Get Started
1. Go to the [Discussions tab](https://github.com/accordproject/web-components/discussions).
2. Search for existing discussions to see if your question has already been answered.
3. If not, start a new discussion with a clear and descriptive title.

---

## 🛠️ How to Contribute

### 1. Fork the Repository
- Click the **"Fork"** button on the repository’s page to create a copy of the repository under your GitHub account.

### 2. Clone the Repository
- Clone your forked repository to your local machine:
```bash
git clone https://github.com/your-username/web-components.git
cd web-components