Skip to content

Commit a7462ed

Browse files
committed
docs(CONTRIBUTING): improve formatting and readability of contribution guidelines
1 parent ecb6c68 commit a7462ed

File tree

1 file changed

+31
-16
lines changed

1 file changed

+31
-16
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
# Contributing to meonode-ui
22

3-
First off — thank you for considering contributing to meonode-ui! Your help improves the project for everyone. This document describes how to report issues, propose changes, and contribute code in a way that keeps the project healthy and easy to maintain.
3+
First off — thank you for considering contributing to meonode-ui! Your help improves the project for everyone. This
4+
document describes how to report issues, propose changes, and contribute code in a way that keeps the project healthy
5+
and easy to maintain.
46

57
## Table of contents
68

79
- [Code of Conduct](#code-of-conduct)
810
- [How can I contribute?](#how-can-i-contribute)
9-
- [Reporting bugs](#reporting-bugs)
10-
- [Suggesting enhancements](#suggesting-enhancements)
11-
- [Discussing ideas](#discussing-ideas)
11+
- [Reporting bugs](#reporting-bugs)
12+
- [Suggesting enhancements](#suggesting-enhancements)
13+
- [Discussing ideas](#discussing-ideas)
1214
- [Development setup](#development-setup)
1315
- [Making changes (Pull Requests)](#making-changes-pull-requests)
14-
- [Branching and commit messages](#branching-and-commit-messages)
15-
- [Tests and linting](#tests-and-linting)
16-
- [PR checklist](#pr-checklist)
16+
- [Branching and commit messages](#branching-and-commit-messages)
17+
- [Tests and linting](#tests-and-linting)
18+
- [PR checklist](#pr-checklist)
1719
- [Style guide](#style-guide)
1820
- [Releasing & changelog](#releasing--changelog)
1921
- [Getting help / contact](#getting-help--contact)
@@ -22,15 +24,17 @@ First off — thank you for considering contributing to meonode-ui! Your help im
2224

2325
## Code of Conduct
2426

25-
This project follows a [Code of Conduct]. Please be respectful and kind. If you encounter unacceptable behavior, report it to the maintainers.
27+
This project follows a [Code of Conduct]. Please be respectful and kind. If you encounter unacceptable behavior, report
28+
it to the maintainers.
2629

2730
[Code of Conduct]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/
2831

2932
---
3033

3134
## How can I contribute?
3235

33-
Contributions are welcome in many forms: filing issues, suggesting features, improving documentation, or sending code changes.
36+
Contributions are welcome in many forms: filing issues, suggesting features, improving documentation, or sending code
37+
changes.
3438

3539
### Reporting bugs
3640

@@ -48,33 +52,38 @@ Example issue template (you can copy/paste):
4852
Title: "Button: style props not applied when using as()"
4953

5054
Body:
55+
5156
- Steps to reproduce:
52-
1. Create a Button with prop `color: "red"`.
53-
2. Observe styles not applied.
57+
1. Create a Button with prop `color: "red"`.
58+
2. Observe styles not applied.
5459
- Expected behavior: Color prop should apply to the rendered element.
5560
- Environment: Node 22.17.1, Yarn 4.9.1 (stable), macOS 26
5661

5762
### Suggesting enhancements
5863

5964
Feature requests are welcome. Please open an issue with:
65+
6066
- The problem you're trying to solve,
6167
- Why the current behavior is insufficient,
6268
- Example API you'd like to see,
6369
- Any backward compatibility concerns.
6470

6571
### Discussing ideas
6672

67-
For larger design discussions or proposals, opening a GitHub Discussion or drafting a proposal in the issue tracker helps get feedback before investing implementation time.
73+
For larger design discussions or proposals, opening a GitHub Discussion or drafting a proposal in the issue tracker
74+
helps get feedback before investing implementation time.
6875

6976
---
7077

7178
## Development setup
7279

7380
Prerequisites
81+
7482
- Node.js (LTS recommended; >= 22)
7583
- Yarn (Berry/Plug'n'Play recommended since the repository includes .yarnrc.yml), or use npm if you prefer.
7684

7785
Quick start
86+
7887
```bash
7988
# clone
8089
git clone https://github.com/l7aromeo/meonode-ui.git
@@ -95,8 +104,11 @@ yarn format
95104
```
96105

97106
Notes
98-
- Husky hooks may run on commit (pre-commit / pre-push). If you need to bypass hooks: `git commit --no-verify` (use sparingly).
99-
- The repository includes a prepublish script; if you plan to test publishing locally, inspect `prepublish.sh` before running it.
107+
108+
- Husky hooks may run on commit (pre-commit / pre-push). If you need to bypass hooks: `git commit --no-verify` (use
109+
sparingly).
110+
- The repository includes a prepublish script; if you plan to test publishing locally, inspect `prepublish.sh` before
111+
running it.
100112

101113
---
102114

@@ -151,15 +163,18 @@ Before requesting a review, ensure:
151163

152164
## Releasing & changelog
153165

154-
Releases should follow semantic versioning. The repository contains a CHANGELOG.md — update it for user-facing changes. Maintainers can use `prepublish.sh` and the release automation configured for publishing.
166+
Releases should follow semantic versioning. The repository contains a CHANGELOG.md — update it for user-facing changes.
167+
Maintainers can use `prepublish.sh` and the release automation configured for publishing.
155168

156-
If you contribute a user-facing change, leave a short changelog entry in your PR or mention the relevant entry in the issue.
169+
If you contribute a user-facing change, leave a short changelog entry in your PR or mention the relevant entry in the
170+
issue.
157171

158172
---
159173

160174
## Getting help / contact
161175

162176
If you need help:
177+
163178
- Open an issue describing the problem and steps you took.
164179
- Start a discussion for design-level questions.
165180

0 commit comments

Comments
 (0)