Skip to content

Improve Documentation & Contributor Guidelines #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
5 tasks
denironyx opened this issue Feb 16, 2025 · 0 comments
Open
5 tasks

Improve Documentation & Contributor Guidelines #6

denironyx opened this issue Feb 16, 2025 · 0 comments

Comments

@denironyx
Copy link
Contributor

🔹 Description:
To make it easier for contributors, we need clear documentation, including how to use our scripts, contribute new datasets, and understand the schema.

🔹 Expectations:

  • Write a detailed README explaining the project's goals.
  • Create contribution guidelines for new contributors.
  • Provide code examples for using the dataset.
  • Set up a template for GitHub Issues & Pull Requests.
  • Organize documentation into sections (e.g., Data Sources, API Usage, Installation).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant