Docs: Refactor README, centralize contributions, and add CONTRIBUTING.md #34
Conversation
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
Updated README to reflect new project name and structure.
Removed duplicate links to 'Interactive Maps with Folium' from the README.
Added a contributing guide for the D4D Tutorials repository, outlining how to request and add tutorials.
Added a tutorial on converting Jupyter notebooks to Streamlit dashboards, including installation instructions and an example use case.
Added instructions to run the Streamlit application.
Updated load_data function to ignore comment lines in CSV.
Updated the disclaimer to clarify that the data is fictitious and created synthetically.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hello, Data for Democracy team!
This PR is a suggestion for "housekeeping" (cleaning and organizing) the tutorial repository. The goal is to make it more welcoming and clear for new members, as well as optimize the contribution process.
Based on the suggestions for improvement, the changes are:
1. Enhanced Introduction
The
README.mdhas been updated with a stronger introduction, explaining the purpose of the repository in the context of the D4D mission.2. Improved Navigation
A Table of Contents has been added to
README.mdto allow users to quickly find the topics or tutorials they are looking for.3. Centralization of Contributions
To simplify, the
Looking for Something?andContributingsections in the README have been unified. The link to the Google Sheet (which is outdated and disrupts the workflow) has been removed, directing all tutorial requests and submissions to GitHub Issues.4. New Contribution Guide (Suggestion 2)
A new
CONTRIBUTING.mdfile has been created to formalize the contribution process. It explains in clear steps how a volunteer can:I hope these changes help revitalize the repository and make it easier for new volunteers to join! I am available for any adjustments.