You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+31-16Lines changed: 31 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,21 @@
1
1
# Contributing to meonode-ui
2
2
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
Feature requests are welcome. Please open an issue with:
65
+
60
66
- The problem you're trying to solve,
61
67
- Why the current behavior is insufficient,
62
68
- Example API you'd like to see,
63
69
- Any backward compatibility concerns.
64
70
65
71
### Discussing ideas
66
72
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.
68
75
69
76
---
70
77
71
78
## Development setup
72
79
73
80
Prerequisites
81
+
74
82
- Node.js (LTS recommended; >= 22)
75
83
- Yarn (Berry/Plug'n'Play recommended since the repository includes .yarnrc.yml), or use npm if you prefer.
- 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.
100
112
101
113
---
102
114
@@ -151,15 +163,18 @@ Before requesting a review, ensure:
151
163
152
164
## Releasing & changelog
153
165
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.
155
168
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.
157
171
158
172
---
159
173
160
174
## Getting help / contact
161
175
162
176
If you need help:
177
+
163
178
- Open an issue describing the problem and steps you took.
0 commit comments