Skip to content

Commit 3ee060e

Browse files
committed
chore: add CONTRIBUTING.md
1 parent f8c9e92 commit 3ee060e

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing Guideline
2+
3+
Please open an issue to discuss the contribution you wish to make before submitting any changes.
4+
5+
This way we can guide you through the process and give feedback.

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- [Updating dependencies](#updating-dependencies)
1313
- [Cleanup projects](#cleanup-projects)
1414
- [Tasks to Complete](#tasks-to-complete)
15-
15+
- [Contributions](#contributions)
1616

1717
## Overview
1818

@@ -203,6 +203,12 @@ After creating a new project from this template repository, ensure you update th
203203

204204
Keeping documentation current helps others understand, use, and contribute to the project.
205205

206+
## Contributions
207+
208+
Contributions are welcome! Please open a pull requests for your changes and tickets in case you would like to discuss something or have a question.
209+
210+
Read [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed documentation.
211+
206212
<!-- link reference definition -->
207213
[go-docs]: https://go.dev/doc/install
208214
[mailpit]: https://mailpit.axllent.org/

degit.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
{
33
"action": "remove",
44
"files": [
5-
"README.md",
65
"apps",
76
"packages",
87
"templates",
98
"template-golang",
109
"template-react-app",
1110
"template-react-ssr",
12-
"template-shared-ui"
11+
"template-shared-ui",
12+
"CONTRIBUTING.md",
13+
"README.md"
1314
]
1415
}
1516
]

0 commit comments

Comments
 (0)