search

ansopedia / creator-studio

Ansopedia Creator Studio (ACS) is an open-source content management system (CMS) designed to power Ansopedia, a learning platform. It provides a user-friendly interface for creating, editing, and managing various content types like posts, comments, questions, quizzes, and assets (images, files).
MIT License
1 stars 2 forks source link

FE - Add Essential Documentation for Hacktoberfest Eligibility #12

Closed sanjaysah101 closed 5 days ago

sanjaysah101 commented 5 days ago

Description

To make the repository eligible for Hacktoberfest and encourage contributions from the open-source community, add essential documentation pages. These pages will help new contributors understand the project, how to contribute, and the guidelines for participation.

Tasks

  1. Create README.md:

    • Provide an overview of the project, including its purpose, features, and technologies used.
    • Add sections such as:
      • Project Introduction
      • Getting Started (installation and setup instructions)
      • Usage Instructions (how to run the project locally)
      • API Reference (if applicable)
      • Contributing Guidelines
      • License Information
    • Include badges for Hacktoberfest participation, build status, and license.

  2. Create CONTRIBUTING.md:

    • Provide clear instructions on how to contribute to the repository.
    • Include the following sections:
      • How to fork and clone the repository.
      • Branch naming conventions (e.g., feature/, bugfix/, docs/).
      • How to create a pull request (PR).
      • Code formatting and style guide (e.g., Prettier, ESLint).
      • Link to CODE_OF_CONDUCT.md.

  3. Create CODE_OF_CONDUCT.md:

    • Establish community guidelines to ensure a welcoming and inclusive environment for contributors.
    • Use the Contributor Covenant template as a starting point.
    • Include guidelines on expected behaviour and how to report issues.

  4. Create LICENSE:

    • Choose an appropriate open-source license (e.g., MIT, Apache 2.0) to clarify how others can use the project.
    • Add the license text to the LICENSE file.

  5. Update .github/ISSUE_TEMPLATE.md (Optional):

    • Create a template for submitting issues to ensure all necessary details are included (e.g., description, steps to reproduce, expected behaviour).
    • This can help maintain consistency in issue reports and make it easier for contributors to get started.

  6. Update .github/PULL_REQUEST_TEMPLATE.md (Optional):

    • Create a template for pull requests that includes sections such as:
      • What changes have been made?
      • Screenshots (if applicable).
      • Related issue or task.
      • Checklist for tests and code quality checks.

Acceptance Criteria