Skip to content

Commit 400013e

Browse files
committed
renamed the developer readme in src/README.md to DEVELOPER_README and updated associated references.
-fixed the h1 header in the main readme
1 parent 02268c3 commit 400013e

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Welcome to the Reactime contributing guide!
22

3-
Thank you for investing your time in contributing to our project! :sparkles:.
3+
Thank you for investing your time in contributing to our project! :sparkles:.
44

55
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
66

@@ -13,16 +13,15 @@ To get an overview of the project, read the [README](README.md). Here are some r
1313
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
1414
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
1515

16-
1716
## Getting started
1817

19-
To navigate our codebase with confidence, see the [Developer Guidelines](/src/README.md) :confetti_ball:.
18+
To navigate our codebase with confidence, see the [Developer Guidelines](src/DEVELOPER_README.md) :confetti_ball:.
2019

2120
### Issues
2221

2322
#### Create a new issue
2423

25-
If you spot a problem with the docs, [search if an issue already exists](https://github.com/open-source-labs/reactime/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/open-source-labs/reactime/issues/new).
24+
If you spot a problem with the docs, [search if an issue already exists](https://github.com/open-source-labs/reactime/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/open-source-labs/reactime/issues/new).
2625

2726
#### Solve an issue
2827

@@ -32,14 +31,16 @@ Scan through our [existing issues](https://github.com/open-source-labs/reactime/
3231

3332
#### Make changes in the UI
3433

35-
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
34+
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
3635

3736
#### Make changes locally
3837

3938
1. [Install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
4039

4140
2. Fork the repository.
41+
4242
- Using GitHub Desktop:
43+
4344
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
4445
- Once Desktop is set up, you can use it to [fork the repo](https://github.com/open-source-labs/reactime.git)!
4546

@@ -55,16 +56,17 @@ Commit the changes once you are happy with them.
5556
### Pull Request
5657

5758
When you're finished with the changes, create a pull request, also known as a PR.
58-
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
59+
60+
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
5961
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
6062
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
61-
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
63+
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
6264
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
6365
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
6466
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
6567

6668
### Your PR is merged!
6769

68-
Congratulations :tada::tada: The Reactime team thanks you! :sparkles:.
70+
Congratulations :tada::tada: The Reactime team thanks you! :sparkles:.
6971

7072
Once your PR is merged, your contributions will be publicly visible on [Reactime](https://github.com/open-source-labs/reactime)!

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 align="center">
1+
<h1 align="center">
22

33
<br>
44
<img src ="./assets/logos/chromeExtensionIcons/marqueePromoTitle.png"/>
@@ -178,7 +178,6 @@ In an effort to improve maintainability, scalability, and longevity, we updated
178178

179179
For an improved user experience, we set our sights on several impactful enhancements. First on our list is the reconnection feature, designed as a protective measure for those unexpected moments when a user gets disconnected. In such events, an intuitive pop-up dialog will instantly emerge, offering users a seamless way to dive right back into their session, while also offering the option to download recorded snapshots of state as a JSON file. Complementing this, we've integrated a dynamic status indicator that transparently displays a user's current app status, highlighting whether they're online or offline. But that's not all. We've enriched the application with two vital web performance metrics: Cumulative Layout Shift (CLS) and Interaction to Next Paint (INP). These metrics are pivotal, providing developers with insights into layout stability and responsiveness, empowering them to optimize user interactions with precision.
180180

181-
182181
If you would like to read more about previous releases, click <a href="https://github.com/open-source-labs/reactime/releases">here!</a>
183182

184183
<p align="center">
File renamed without changes.

0 commit comments

Comments
 (0)