diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa267b9..d667348 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 \ No newline at end of file +[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