Skip to content

Add documentation files and contribution guidelines#13

Open
Tfc538 wants to merge 6 commits intooutpoot:mainfrom
Tfc538:docs/project-documentation
Open

Add documentation files and contribution guidelines#13
Tfc538 wants to merge 6 commits intooutpoot:mainfrom
Tfc538:docs/project-documentation

Conversation

@Tfc538
Copy link

@Tfc538 Tfc538 commented Apr 24, 2025

Introduce documentation files including contribution guidelines, onboarding instructions, and contributor recognition. I also added a few copilot context files.

Tfc538 added 3 commits April 24, 2025 13:31
Add essential documentation for the project:
- CONTRIBUTE.md with contribution guidelines
- CONTRIBUTORS.md for recognizing contributors
- ONBOARDING.md with setup instructions

These files will help new contributors understand the project
and get started quickly.
Add essential documentation for the project:
- CONTRIBUTE.md with contribution guidelines
- CONTRIBUTORS.md for recognizing contributors
- ONBOARDING.md with setup instructions

These files will help new contributors understand the project
and get started quickly.
@Tfc538 Tfc538 marked this pull request as ready for review April 24, 2025 13:46
@Tfc538
Copy link
Author

Tfc538 commented Apr 24, 2025

This pull request introduces documentation updates and project guidelines for the Vyntr project, covering coding standards, contribution processes, component-specific instructions, and onboarding for new developers. These changes aim to standardize practices, improve developer onboarding, and provide detailed guidance for working on various components of the project.

Documentation and Guidelines Updates:

  • Coding Standards:

    • Added coding-standards.md with language-specific best practices for Rust, TypeScript/JavaScript, Python, and SQL.
    • Emphasized tools like cargo fmt, cargo clippy, ESLint, and PEP 8 for maintaining code quality.
  • Contribution Guidelines:

    • Introduced contribution-guidelines.md detailing branch naming conventions, commit message formatting, pull request processes, and testing guidelines.
    • Included examples and templates for consistent contributions.
  • Component-Specific Instructions:

    • Added detailed guidelines for components such as Genesis (crawler), Pulse (search indexing), Lexicon (dictionary service), and Website (frontend). [1] [2] [3] [4]
    • Defined coding standards, performance optimization tips, and component structures.

Project Overview and Onboarding:

  • Project Overview:

    • Created project-overview.md summarizing Vyntr's architecture, components, and technology stack.
    • Highlighted the integration of PostgreSQL, AWS S3, and other tools.
  • Onboarding Guide:

    • Added ONBOARDING.md to assist new developers with setup, workflows, and troubleshooting.
    • Included step-by-step instructions for setting up the development environment and working with each component.

Repository Enhancements:

  • Copilot Context Configuration:

    • Updated .vscode/settings.json to include new documentation files for GitHub Copilot context.
  • Acknowledgments and Recognition:

    • Updated CONTRIBUTORS.md to recognize contributors and provide instructions for adding new names.

@Tfc538
Copy link
Author

Tfc538 commented Apr 26, 2025

I just noticed that there are lots of files in here I didn't mean to PR yet (all the workflows) i didnt test them yet and they probably have lots of issues

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

Successfully merging this pull request may close these issues.

1 participant