This repository stores organization-wide community files for ReadLab X.
Use this guide as the default contribution policy for repositories in the
organization when a repository does not provide its own CONTRIBUTING.md.
Before you open an issue or pull request, make sure your contribution matches the purpose of the target repository.
- Use issues for bugs, content gaps, or concrete feature requests.
- Use pull requests for focused, reviewable changes.
- Keep changes small when possible.
- Open a discussion first if the proposal changes product direction, information architecture, or public positioning.
If you want to contribute code, content, or design work, follow these steps:
- Fork the repository or create a working branch.
- Read the repository README and any local contribution notes.
- Make a focused change with a clear purpose.
- Verify the change locally when the repository includes checks or build commands.
- Open a pull request with enough context for review.
When you open a pull request, make sure it is easy to review.
- Explain what changed and why it matters.
- Link related issues, if any exist.
- Include screenshots for visible UI changes.
- Call out follow-up work or known limitations.
- Avoid mixing unrelated changes in one pull request.
ReadLab X values clarity, restraint, and durable structure.
- Prefer plain language over hype.
- Write for readers first, not for internal teams.
- Keep interfaces and documentation focused.
- Preserve established naming, tone, and visual direction unless the change is intentionally redefining them.
If you are not sure where a change belongs, start with:
- GitHub organization: https://github.com/readlab-x
- Contact: mailto:6iedog@gmail.com
After you open a contribution, respond to review comments, update the branch as needed, and keep the discussion attached to the pull request so the change history stays easy to follow.