GH-83: Refactoring README.md and Adding Documents #84
Conversation
Summary of ChangesHello @yasandu0505, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's foundational documentation. It introduces essential community-standard files such as a Code of Conduct, Contributing Guidelines, Security Policy, and the Apache 2.0 License. Concurrently, the README.md has been refactored to be more informative and user-friendly, integrating these new documents and clarifying project setup, usage, and features. The overall aim is to foster a more welcoming and organized environment for contributors and users alike. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the project's documentation by adding standard files like CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, and SECURITY.md, and by refactoring the README.md. The new structure is much clearer and more welcoming to users and contributors.
My review includes suggestions to fix a few issues such as a broken link, typos, and formatting problems in the documentation. The most critical issue is to fill in the copyright information in the LICENSE file. I've also noticed that several files are missing a final newline character, which is a good practice to add for better compatibility with various tools.
I am having trouble creating individual review comments. Click here to see my feedback.
LICENSE (189)
The copyright notice is a placeholder. It's important to fill this in with the correct year and copyright owner for the license to be properly applied.
Copyright 2024 Lanka Data Foundation
README.md (116)
This link for the 'Contributing Guide' incorrectly points to SECURITY.md. It should point to CONTRIBUTING.md.
- Please see our [Contributing Guide](CONTRIBUTING.md).
CODE_OF_CONDUCT.md (31)
Please add a newline at the end of the file. It's a good practice for POSIX-compliance and to avoid issues with some tools.
CONTRIBUTING.md (30-36)
The development setup instructions are commented out. Please uncomment this section and provide the specific steps required to set up the development environment for this project. The current example is a good starting point.
### Development Setup
Provide step-by-step instructions to set up the development environment.
Example:
1. Fork the repository
2. Clone your fork: `git clone https://github.com/your-username/project.git`
3. Install dependencies: `pip install -r requirements.txt`
4. Create a branch: `git checkout -b feature/your-feature-name`
CONTRIBUTING.md (125)
There is a typo in the word "reffer". It should be "refer".
- Please refer to the [Project Documentation](README.md)
CONTRIBUTING.md (129)
Please add a newline at the end of the file. It's a good practice for POSIX-compliance and to avoid issues with some tools.
LICENSE (201)
Please add a newline at the end of the file. It's a good practice for POSIX-compliance and to avoid issues with some tools.
README.md (10-16)
This note about setting the PATH for --user installations is very helpful for users to avoid command not found errors. It was removed in this change. Please consider adding it back.
README.md (77)
There is a typo here. "re-try thm" should be "retry them".
- **Error handling**: Automatic retry for failed downloads and check for unavailable documents and retry them.
README.md (90-96)
The ASCII art for the directory structure in this section is misaligned, which makes it hard to read. The vertical bars should line up correctly.
│
│ ├── records/
│ │ ├── successfully_archived.csv
│ │ ├── failed_to_archive.csv
│ │ ├── document_unavailable.csv
│ │ └── document_classification.csv
│ └── ...
README.md (129)
Please add a newline at the end of the file. It's a good practice for POSIX-compliance and to avoid issues with some tools.
SECURITY.md (24)
Please add a newline at the end of the file. It's a good practice for POSIX-compliance and to avoid issues with some tools.
README.md
Outdated
| ## Output Structure | ||
|
|
||
| **4. Go to APIs & Services > Credentials** | ||
|
|
||
| **5. Click "Create Credentials" → "OAuth Client ID"** | ||
|
|
||
| **6. Choose Desktop App** | ||
|
|
||
| **7. Download the file — it's called `credentials.json`** | ||
|
|
||
| **8. Create a folder called `credentials` somewhere in your computer** | ||
|
|
||
| **9. Place the `credentials.json` inside the `credentials`** | ||
|
|
||
| **10. Copy the path and update the config.yaml file** | ||
|
|
||
| ## ✨ Features | ||
|
|
||
| - **Resume capability**: If interrupted, run the same command again to resume downloads | ||
| - **Graceful shutdown**: Press `Ctrl+C` to stop after current downloads complete | ||
| - **Progress tracking**: Real-time download progress with statistics | ||
| - **Smart filtering**: Filter by year, month, day, and language | ||
| - **File validation**: Automatic validation of downloaded PDF files | ||
| - **Get new updates**: Can get new updates years and other data | ||
| - **Organized storage**: Files saved in structured folders: `year/month/day/gazette_id/` | ||
| - **Comprehensive logging**: Detailed logs for successful and failed downloads | ||
| - **Error handling**: Automatic retry for failed downloads with intelligent error reporting | ||
|
|
||
| ## 📁 Output Structure | ||
|
|
||
| Downloads are organized as: | ||
| Downloaded documents are organized as: |
There was a problem hiding this comment.
This content maybe too much for the README.md it gives unnecessary amount of details in the first glance.
So Follow what is done in https://github.com/ChanukaUOJ/OpenGIN/tree/readme-update?tab=readme-ov-file
And work on this part.
README.md
Outdated
|
|
||
| | Feature | Description | | ||
| |---------|-------------| | ||
| | Document Categorisation | Categorise documents based on their content. | |
There was a problem hiding this comment.
| | Document Categorisation | Categorise documents based on their content. | | |
| | Document Categorization | Categorize documents based on their content. | |
LICENSE
Outdated
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright [yyyy] [name of copyright owner] |
There was a problem hiding this comment.
| Copyright [yyyy] [name of copyright owner] | |
| Copyright 2026 Lanka Data Foundation |
3 participants
I have added/updated the documentations referring to the template.
This PR closes #83