search

c-code-x / codex-website

https://codex-website-nu.vercel.app
5 stars 17 forks source link

Update Contribution Guidelines and Templates #70

Open Jaideep-C opened 7 months ago

Jaideep-C commented 7 months ago

Issue Description

Problem

The current issue templates in the repository are outdated and insufficient, causing confusion among contributors and hindering the smooth process of opening and resolving issues. The lack of detailed instructions and examples is impeding the quality of issue reports, making it difficult for contributors to provide necessary information.

Proposed Solution

We need to update the contribution guidelines and issue templates to establish a standardized approach for contributors. The guidelines should cover essential aspects such as PR format, code quality standards, commit message conventions, and general issue reporting guidelines.

Changes to be Documented

  1. Contribution Guidelines:

    • Clarify the process for submitting issues and pull requests.
    • Specify the expected format for pull requests.
    • Define code formatting and quality standards.
    • Outline commit message format and conventions.

  2. Issue Templates:

    • Provide detailed instructions for opening bug fixes, feature requests, and other types of issues.
    • Include examples of well-structured issue reports.
    • Address common questions and concerns in the templates.

Expected Benefits

  1. Standardization:

    • Ensure that all contributors follow the same set of guidelines.
    • Facilitate a uniform and streamlined contribution process.

  2. Clarity:

    • Reduce confusion by providing clear and comprehensive instructions.
    • Enhance the quality of issue reports and pull requests.

  3. Efficiency:

    • Expedite issue resolution by improving the information provided in issue reports.
    • Streamline the review and merging process for pull requests.

Action Items

  1. Collaborate on defining and documenting contribution guidelines.
  2. Revise and enhance the existing issue templates.
  3. Include examples and illustrations to aid contributors in understanding the guidelines.
  4. Review and approve the updated guidelines and templates.

Assignees: @SaiSantoshPradyumna @breathecode6365

Labels: Documentation, Enhancement, Help Wanted

Harsha9554 commented 7 months ago

I propose that we create three new issue templates using GitHub’s built-in templates feature. The templates would be designed to cover common types of issues, such as bug reports, feature requests, and general feedback. By using these templates, contributors will be able to provide more detailed and structured issue reports, which will help us to resolve issues more efficiently.

GitHub’s built-in templates feature is better than creating custom templates because it provides a standardized structure for issues and pull requests in your repository. You can create templates for issues, pull requests, and other types of content, and GitHub will use these templates to pre-populate the issue or pull request with the appropriate content.

Each template will provide detailed instructions for opening issues and pull requests, including examples of well-structured issue reports and pull requests.

@Jaideep-C

Jaideep-C commented 7 months ago

Thanks @Harsha9554 just what we were expecting.

breathecode6365 commented 2 weeks ago

Unfortunately, we lost the alpha branch and have since re-based the repository with the main, beta, and dev branches to maintain our standards. The changes from PR #71 have now been successfully recovered and merged into the dev branch.

breathecode6365 commented 2 weeks ago

Issue Update: Documentation Refactoring Needed

Problem

The current issue templates and contribution guidelines were previously updated to address confusion among contributors and improve the quality of issue reports and pull requests. However, the project recently underwent significant technical changes, including an upgrade from Next.js 10 to Next.js 14, resulting in a new project structure.

Proposed Solution

We need to further update and refactor the contribution guidelines and issue templates to align with the updated project structure. This will ensure that all documentation is relevant and helpful to contributors working with the new setup.

Changes to be Documented

  1. Contribution Guidelines:

    • Reflect the new process for submitting issues and pull requests in the updated project structure.
    • Update the expected format for pull requests to match the new standards.
    • Revise code formatting and quality standards as per the upgraded framework.
    • Update commit message format and conventions, if necessary.

  2. Issue Templates:

    • Provide revised instructions for opening bug fixes, feature requests, and other types of issues in the new project context.
    • Include updated examples of well-structured issue reports.
    • Address any new common questions and concerns arising from the technical upgrade.

Expected Benefits

  1. Standardization:

    • Ensure that all contributors follow updated guidelines that reflect the new project structure.
    • Facilitate a uniform and streamlined contribution process in the new technical context.

  2. Clarity:

    • Reduce confusion by providing clear and comprehensive instructions relevant to the upgraded framework.
    • Enhance the quality of issue reports and pull requests in line with the new project setup.

  3. Efficiency:

    • Expedite issue resolution by improving the information provided in issue reports, considering the new structure.
    • Streamline the review and merging process for pull requests within the upgraded framework.

Action Items

  1. Collaborate on defining and documenting updated contribution guidelines.
  2. Revise and enhance the existing issue templates to reflect the new project structure.
  3. Include examples and illustrations to aid contributors in understanding the updated guidelines.
  4. Review and approve the updated guidelines and templates.

Request for Help

We are seeking assistance in refactoring the documentation based on the updated project structure. Contributors are requested to update the contribution guidelines and issue templates to reflect the recent changes.

Submission Instructions

Please submit your PRs to the dev branch to ensure that all changes are properly reviewed and integrated.

Labels: Documentation, Enhancement, Help Wanted

Thank you for your contributions and support in maintaining the quality and clarity of our project documentation.