Skip to content

Commit 4ae55a5

Browse files
author
Adam Spiers
committed
Make it easier to discover the (excellent) developer docs
As mentioned in #253, it's a real shame to have such great developer docs which are "hidden" by not being conspicuously linked from anywhere. So link to them from the top-level README.md, and also add a CONTRIBUTING.md which is a conventional file location understood by sites such as GitHub: https://github.com/open-source-labs/reactime/community https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#adding-a-contributing-file Partially addresses #253.
1 parent 16879fb commit 4ae55a5

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing to Reactime
2+
3+
Thanks very much for your interest in contributing to this project!
4+
5+
Reactime is an open source project, and we’d really appreciate your
6+
help with improving user experience. Please read [the developer
7+
README](src/README.md), and create a pull request (or issue) to
8+
propose and collaborate on changes to a repository.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Try refreshing the application you want to test and refresh the DevTools by clic
8181

8282
### ❓ <b>I found a bug in Reactime</b>
8383

84-
Reactime is an open source project, and we’d really appreciate your help with improving user experience. Please create a pull request (or issue) to propose and collaborate on changes to a repository.
84+
Reactime is an open source project, and we’d really appreciate your help with improving user experience. Please read [the developer README](src/README.md), and create a pull request (or issue) to propose and collaborate on changes to a repository.
8585

8686
## <b>Features</b>
8787

0 commit comments

Comments
 (0)