How to contribute?
A detailed guide on how to contribute to the Bangladeshi laws project, including guidelines for adding new laws, updating existing ones, and ensuring accuracy and consistency.
Prerequisites
Before contributing, please ensure you have the following:- Basic understanding of Markdown and MDX syntax
- Familiarity with Git and GitHub
- Access to a code editor (e.g., VSCode)
- Basic scraping knowledge (optional, for scraping new laws)
How to Contribute
1. Updating Existing Laws
To update an existing law:- Find the Law: Locate the MDX file for the law you want to update in the appropriate volume folder.
- Edit the MDX File:
- Open the file in your code editor.
- Make necessary changes to the content, ensuring you maintain the original structure.
- Commit Changes:
- Save the file.
- Commit the changes with a descriptive message (e.g., “Update Act No. XX of YYYY”).
- Push Changes: Push your changes to the remote repository.
- Create a Pull Request:
- Go to the GitHub repository.
- Create a new pull request with a clear title and description of your changes.
2. Verification and Status Updates
You can contribute by verifying the accuracy and completeness of laws on our platform. This involves two types of updates in our laws index:Status Column Updates
Review each law’s current legal standing and update the Status column accordingly:- Active: The law is currently in force and enforceable
- Repealed: The law has been officially revoked or superseded
- Amended: The law has been modified but remains active
- Not Verified: Default status indicating the law requires review
Checked Column Updates
Verify content accuracy by comparing our website version with the original official sources, then update the Checked column:- Yes: Content has been verified against official sources and is accurate
- No: Content requires verification or has known discrepancies
- Partial: Some sections verified, others need review
Verification Process
- Source Comparison: Compare our content with the official Bangladesh legal database
- Content Review: Check for formatting, completeness, and accuracy
- Update Status: Modify both Status and Checked columns as appropriate
- Document Changes: Include detailed commit messages explaining your updates
Guidelines for Contributions
Formatting
- Use Markdown and MDX syntax for formatting. For more customize styling, refer to the Mintlify Documentation
Content Accuracy
- Verify the accuracy of the law’s content before adding or updating.
- Ensure that the source link points to the official Bangladesh legal database.
Review Process
- All contributions will be reviewed by the project maintainers.
- You may be asked to make changes or provide additional information.