Issue Addressed
Issue #112: Fix Get Started Link
Summary of the Issue
The "Get Started" button in the footer of the website was redirecting to /group/new
, which needed to be updated to /create-group
to align with recent changes in the app's routing structure.
Preparation and Setup
To fix this issue, I first set up the project locally:
- Forked and cloned the repository to ensure a separate copy for making changes.
-
Installed dependencies using
npm install
to prepare the project for development. - Ran the project locally to familiarize myself with the existing navigation structure and locate the “Get Started” link in the codebase.
Learning and Fix Implementation
Navigating the project, I identified the footer component and located the "Get Started" button. The link was previously hardcoded to /group/new
, so I changed it to /create-group
in the component. I then:
- Tested the link locally by running the app on
localhost
. - Confirmed that the button redirected correctly to the new path
/create-group
.
Handling Lock Files
In the initial commit, I included the package-lock.json
file, which the project maintainer requested to be removed. To address this:
- I deleted both
package-lock.json
andpnpm-lock.yaml
files locally. - After removing them, I committed and pushed the changes. However, GitHub still displayed
pnpm-lock.yaml
in the pull request, likely due to cache or sync issues. - I resolved this by force-pushing the branch to refresh the pull request, ensuring both lock files were excluded.
Challenges and Interactions
The most challenging part of this task was dealing with the lingering pnpm-lock.yaml
file in the PR. I had to troubleshoot this by experimenting with Git commands to forcefully update GitHub’s display of the files.
The maintainer, @harshmangalam, was very helpful, providing feedback that guided me toward the best practices for managing unnecessary files in PRs.
What I Learned
-
File Tracking in Git: I learned about using
git rm --cached
to ensure unwanted files are completely removed from Git tracking. - Force Sync with GitHub: This issue taught me when and how to use a forced push to resolve GitHub sync issues.
- Working with Maintainers: It reinforced the importance of clear communication and responsiveness to feedback in open-source projects.
Link to the Pull Request
Pull Request #115: Fix Get Started Link in Footer
Reflection and Next Steps
This experience underscored the need for attention to detail in open source, especially in adhering to repository guidelines. Next time, I’ll double-check any included files to avoid unnecessary additions in PRs. Overall, it was a great learning opportunity to practice collaboration and tackle minor technical issues.
Top comments (0)