Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add and Update Prize Specifications for Subfolders #1

Open
3 tasks
apruden2008 opened this issue May 29, 2024 · 0 comments
Open
3 tasks

Add and Update Prize Specifications for Subfolders #1

apruden2008 opened this issue May 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@apruden2008
Copy link
Contributor

Description

The prize specifications for each category of the ZPrize competition should be added to the corresponding subfolders in the repository. These specifications should also be updated to reflect the actual outcomes and details of the competition. Additionally, instructions on how to use the test harness should be included and kept up-to-date.

Motivation

Providing detailed and updated prize specifications within each subfolder will:

  • Enhance clarity and usability for contributors and users.
  • Ensure that the specifications reflect the most accurate and recent information based on the competition results.
  • Provide necessary instructions for using the test harness, facilitating better understanding and replication of results.

Requirements

  • Add Prize Specifications:

    • Include a detailed specification document in each subfolder corresponding to the prize categories.
    • Ensure the document covers all aspects of the competition requirements, criteria, and objectives.
  • Update Based on Competition Outcomes:

    • Review the original specifications and update them to reflect any changes or insights gained from the actual competition.
    • Include details on the winning entries and any modifications or improvements suggested by the competition results.
  • Include Test Harness Instructions:

    • Add a section in the specification document with clear, step-by-step instructions on how to use the test harness.
    • Ensure the instructions are detailed enough to allow users to replicate the testing and validation process accurately.

Implementation

  • [ ]Create a new specification document as a markdown for each prize category within the respective subfolders. Can use the original specifications previously shared to competitors as a starting point.
  • Update the specifications based on the latest competition outcomes and feedback.
  • Write detailed instructions on how to use the test harness and include them in the specification document.
  • Review and validate the updates to ensure they are comprehensive and accurate.

Additional Information

  • Reference any existing documentation or resources that can assist in updating the specifications.
  • If necessary, collaborate with competition participants and organizers to gather the most accurate and relevant information.
@apruden2008 apruden2008 added the documentation Improvements or additions to documentation label May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant