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

chore: update docs #12

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

chore: update docs #12

wants to merge 6 commits into from

Conversation

loftwah
Copy link
Member

@loftwah loftwah commented Feb 11, 2024

This is the PR for my initial updates

Step 1: README.md

  • Purpose: Offer an overview of the project, including its motivation, features, installation instructions, usage, and contribution guidelines.
  • Action: Create or update the README.md file with detailed information about the "Studio" project. Ensure it's welcoming and informative for both users and potential contributors.

Step 2: CONTRIBUTING.md

  • Purpose: Guide contributors through the process of participating in your project.
  • Action: Draft a CONTRIBUTING.md file that outlines how to report bugs, suggest features, submit pull requests, and the coding standards or commit message conventions to follow.

Step 3: Code of Conduct

  • Purpose: Establish a set of principles for behavior to foster a respectful and inclusive community.
  • Action: Adopt a Code of Conduct, such as the Contributor Covenant, and customize it if necessary to match your project's ethos. Save this as CODE_OF_CONDUCT.md in your repository.

Step 4: Issue and Pull Request Templates

  • Purpose: Streamline the submission of issues and pull requests by providing structured formats for contributors to follow.

  • Action:

    • Go to your repository settings and find the section for issue and pull request templates.
    • Create templates for bug reports, feature requests, and pull requests. Ensure these templates guide contributors to provide all necessary information.

Step 5: GitHub Actions for Automation

  • Purpose: Automate workflows to improve efficiency and consistency in handling contributions and repository maintenance.

  • Action:

    • Set up GitHub Actions for common tasks such as:

      • Auto-labeling issues based on their titles or content.
      • Greeting new contributors when they submit issues or pull requests.
    • Explore the GitHub Marketplace for pre-built actions that suit your workflow needs.

Step 6: Project Boards Automation

  • Purpose: Efficiently track and manage project tasks and milestones.
  • Action: Utilize GitHub Actions or project board settings to automate the movement of issues and pull requests across the board, such as moving tasks to "Done" when they're closed.

Step 7: Engage and Maintain

  • Purpose: Keep the community active and the repository up-to-date.

  • Action:

    • Regularly review and merge pull requests, ensuring they meet the project's standards.
    • Update documentation as the project evolves.
    • Engage with your community through discussions, addressing questions, and providing updates on the project's progress.

    It should cover these before it is merged.

@loftwah loftwah self-assigned this Feb 11, 2024
@loftwah
Copy link
Member Author

loftwah commented Feb 11, 2024

All completed besides the ongoing effort that will be to maintain and keep it engaged.

@loftwah loftwah requested a review from ImLunaHey February 11, 2024 04:57
@loftwah loftwah added the feat New feature or request label Feb 11, 2024
@loftwah
Copy link
Member Author

loftwah commented Feb 11, 2024

  • Added GitHub funding information to .github/FUNDING.yml.

  • Added a bug report issue template to .github/ISSUE_TEMPLATE/bug.yml.

  • Added a configuration file for issue templates to .github/ISSUE_TEMPLATE/config.yml.

  • Added a feature request issue template to .github/ISSUE_TEMPLATE/feature_request.yml.

  • Added a pull request template to .github/pull_request_template.md.

  • Added a GitHub Actions workflow for auto-labeling issues to .github/workflows/auto-label.yml.

  • Updated the Code of Conduct in CODE_OF_CONDUCT.md.

  • Updated the contributing guidelines in CONTRIBUTING.md.

  • Updated the README with various information regarding the project, features, technologies used, getting started guide, application structure, configuration details, dependencies, and contribution guidelines.

@loftwah
Copy link
Member Author

loftwah commented Feb 11, 2024

I need to fix action to be starts with instead of contains.

README needs to be more about the future of studio, not what studio used to be.

Add section to say please validate the issue is also on the beta/staging live running dev site.

No verison number at the footer (should be an issue). Or some way to show version.

@loftwah
Copy link
Member Author

loftwah commented Feb 11, 2024

I've made these changes @ImLunaHey if you want to do the README (or at least just give me the points) we're good to go here.

@ImLunaHey ImLunaHey changed the title feat: Loftwah Things chore: update docs Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature or request
Projects
No open projects
Status: In review
Development

Successfully merging this pull request may close these issues.

1 participant