docs: improve contributor onboarding and cross-platform setup#46
Open
adarsh-7-satyam wants to merge 1 commit into
Open
docs: improve contributor onboarding and cross-platform setup#46adarsh-7-satyam wants to merge 1 commit into
adarsh-7-satyam wants to merge 1 commit into
Conversation
Signed-off-by: Adarsh Satyam <adarsh5.satyam@gmail.com>
a42a7f9 to
a4767cb
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR focuses on improving contributor onboarding and cross-platform local setup for the
UNSDG-classifier-toolproject.While exploring the repository and setting up the project locally, I noticed that the current onboarding flow can be slightly challenging for first-time contributors, especially contributors using Windows environments. The existing setup instructions were primarily Linux/macOS-oriented and did not fully cover common setup issues, environment configuration guidance, or troubleshooting steps.
Improving the onboarding experience can help reduce setup friction and make local development more accessible for contributors across different environments.
Problems Identified
1. Cross-platform setup gaps
The setup instructions mainly used Linux/macOS commands such as:
source ./myvenv/bin/activateHowever, Windows contributors typically use PowerShell or CMD, where the activation commands are different.
This could create confusion for contributors trying to run the project locally on Windows.
2. Missing contributor-focused setup documentation
The repository had setup instructions in the README, but there was no dedicated development/onboarding guide covering:
3. Missing environment variable template
The repository did not include a
.env.examplefile, making it difficult for contributors to understand:4. Setup flow clarity
There were a few areas where onboarding clarity could be improved:
Changes Made
Added
DEVELOPMENT.mdCreated a dedicated development and onboarding guide containing:
Improved README setup section
Updated the README to:
DEVELOPMENT.mdguide.Added
backend/.env.exampleAdded an example environment configuration template to help contributors understand optional configuration variables such as:
GITHUB_TOKENOSDG_TOKENThe template intentionally avoids real secrets and clearly documents that the variables are optional.
Added troubleshooting guidance
Documented common onboarding issues including:
Impact
These improvements aim to: