Skip to content

Commit d52f795

Browse files
authored
Merge pull request #354 from oslabs-beta/master
Merge V26 into OS Labs Main Reactime Repository
2 parents 29f4f56 + d0a0b02 commit d52f795

File tree

454 files changed

+8003
-11284
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

454 files changed

+8003
-11284
lines changed

.travis.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 77 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,107 @@
1-
# Welcome to the Reactime contributing guide!
1+
# Contributing to Reactime :sparkles:
22

3-
Thank you for investing your time in contributing to our project! :sparkles:.
3+
Thank you for your interest in making Reactime even better! :heart_eyes: Your help is invaluable, and we appreciate every contribution, big or small. This guide will walk you through the process of opening issues, creating pull requests, and navigating our workflow.
44

5-
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
5+
## New Contributor Guide :hatching_chick:
66

7-
## New contributor guide
7+
Whether you’re brand new to open source or a seasoned pro, we encourage you to:
88

9-
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
9+
- **Check out our [README](README.md).**
10+
It’ll give you a birds-eye view of what Reactime does and how you can get involved.
11+
- **Explore these helpful resources:**
12+
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
13+
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
14+
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
15+
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
1016

11-
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
12-
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
13-
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
14-
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
17+
## Getting Started :rocket:
1518

16-
## Getting started
19+
If you want to understand the codebase in more detail, take a look at our [Developer Guidelines](src/DEVELOPER_README.md). :confetti_ball:
1720

18-
To navigate our codebase with confidence, see the [Developer Guidelines](src/DEVELOPER_README.md) :confetti_ball:.
21+
### Issues :eyes:
1922

20-
### Issues
23+
#### Creating a New Issue :new:
2124

22-
#### Create a new issue
25+
1. **Check existing issues.**
26+
Before opening a new issue, please [search if it already exists](https://github.com/open-source-labs/reactime/issues).
2327

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).
28+
2. **Open your own issue.**
29+
If you can’t find an existing issue, feel free to [open a new one](https://github.com/open-source-labs/reactime/issues/new) to report bugs, request features, or suggest improvements.
2530

26-
#### Solve an issue
31+
#### Solving an Issue :wrench:
2732

28-
Scan through our [existing issues](https://github.com/open-source-labs/reactime/issues) to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
33+
1. **Pick an issue.**
34+
Browse through our [open issues](https://github.com/open-source-labs/reactime/issues). We don’t officially assign them, so if something sparks your interest, go for it!
2935

30-
### Make Changes
36+
2. **Open a pull request.**
37+
Once you’re ready to propose a fix or feature, you can open a PR referencing the issue you’re solving.
3138

32-
#### Make changes in the UI
39+
### Make Changes :rainbow:
3340

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.
41+
#### Small Edits in the UI :pencil2:
3542

36-
#### Make changes locally
43+
- Click **Make a contribution** at the bottom of any documentation page to quickly fix typos, broken links, or small wording changes.
44+
- This will take you directly to the `.md` file, where you can make edits and open a pull request.
3745

38-
1. [Install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
46+
#### Larger Changes Locally :computer:
3947

40-
2. Fork the repository.
48+
1. **Install Git LFS.**
49+
Follow the instructions [here](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
4150

42-
- Using GitHub Desktop:
51+
2. **Fork the Repository.**
4352

44-
- [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.
45-
- Once Desktop is set up, you can use it to [fork the repo](https://github.com/open-source-labs/reactime.git)!
53+
- **GitHub Desktop:**
54+
[Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) walks you through setup. Then, you can [fork the repo](https://github.com/open-source-labs/reactime.git) right from GitHub Desktop!
55+
- **Command Line:**
56+
[Fork the repo](https://github.com/open-source-labs/reactime.git) and clone your fork locally so you can work on your own copy.
4657

47-
- Using the command line:
48-
- [Fork the repo](https://github.com/open-source-labs/reactime.git) so that you can make your changes without affecting the original project until you're ready to merge them.
58+
3. **Create a working branch.**
59+
Name it something descriptive (e.g., `feature/new-feature` or `fix/typo-in-docs`).
4960

50-
3. Create a working branch and start with your changes!
61+
### Commit Your Changes :white_check_mark:
5162

52-
### Commit your update
63+
When you’re happy with your updates:
5364

54-
Commit the changes once you are happy with them.
65+
1. **Commit them locally.**
66+
Write clear commit messages describing _what_ you changed and _why_.
5567

56-
### Pull Request
68+
2. **Push to your branch.**
69+
This makes your changes visible on GitHub.
5770

58-
When you're finished with the changes, create a pull request, also known as a PR.
71+
### Open a Pull Request :arrows_counterclockwise:
5972

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.
61-
- 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.
62-
- 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.
63-
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
64-
- 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.
65-
- 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).
66-
- 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.
73+
Once you’ve finished working and pushed your code:
6774

68-
### Your PR is merged!
75+
1. **Create the PR.**
76+
Click on **Compare & pull request** on your branch to open a new PR.
6977

70-
Congratulations :tada::tada: The Reactime team thanks you! :sparkles:.
78+
2. **Fill the “Ready for review” template.**
79+
This helps reviewers quickly understand the context and purpose of your changes.
7180

72-
Once your PR is merged, your contributions will be publicly visible on [Reactime](https://github.com/open-source-labs/reactime)!
81+
3. **Link Issues.**
82+
If your PR fixes or relates to an existing issue, [link it](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) in the PR description.
83+
84+
4. **Allow Maintainer Edits.**
85+
Check the box so our team can help update your branch if needed.
86+
87+
5. **Address Feedback.**
88+
If reviewers suggest changes, you can:
89+
90+
- Apply **suggested changes** directly on the GitHub UI.
91+
- Make edits in your local branch and push them.
92+
93+
6. **Resolve Conversations.**
94+
Mark each PR comment as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations) once you’ve addressed it.
95+
96+
7. **Handle Merge Conflicts.**
97+
Check out [this tutorial](https://github.com/skills/resolve-merge-conflicts) if you get stuck.
98+
99+
## Your PR is Merged! :tada:
100+
101+
**Congratulations and thank you!** :dancer: :dancer: Once we merge your PR, your contributions become part of Reactime. We appreciate every contribution, and we hope you’ll stick around for more.
102+
103+
> If you have any further questions or ideas, don’t hesitate to open another issue or join the conversation in the repo!
104+
105+
---
106+
107+
Happy coding and welcome to the Reactime community! :sparkles:

Dockerfile

Lines changed: 0 additions & 4 deletions
This file was deleted.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 reactime
3+
Copyright (c) 2025 reactime
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)