search

Shared-IDE / free-editor

MIT License
6 stars 0 forks source link

Feature: Create an Initial AnalogJS App and Set Up Open Source Repository #1

Closed monacodelisa closed 2 weeks ago

monacodelisa commented 3 weeks ago

Type of feature

✨ Feature

Description:

Create a simple AnalogJS app by setting up the initial project structure using the AnalogJS framework. Once the app is created, open-source the repository and add essential files for contributing to the project.

Tasks:

  1. AnalogJS App Setup

    • Initialize a new AnalogJS project.
    • Push the app to the repository.

  2. Repository Setup

    • Set the repository visibility to public.
    • Add the following files:
      • README.md: Include project overview, installation instructions, usage guidelines, and any key details.
      • CONTRIBUTING.md: Provide clear contribution guidelines (how to fork, open issues, make pull requests, and follow code formatting).
      • LICENSE: Add an appropriate open-source license (MIT, Apache 2.0, etc.).
      • Issue Template: Create an issue template to ensure contributors provide necessary details (title, description, reproduction steps).
      • Pull Request Template: Add a pull request template with checklists for code quality, testing, and review.

  3. Repository Labels

    • Create and edit the following labels for issues and pull requests:
      • bug
      • feature
      • needs triage
      • help wanted
      • good first issue
      • documentation

  4. Issue Workflow

    • add issue workflow

  5. Setup Branches & Branch Protection Rules

    • Set up the main branch as the default branch.
    • Create a development branch for ongoing development work (also protected only for myself)
    • Set up branch protection rules for the main branch:
      • Require pull requests (PRs) for pushing changes to the main branch.
      • Ensure that at least one approved review is required before merging PRs into main.
      • Optionally, enable status checks to ensure that all tests pass before merging.
      • Enforce linear history to prevent merge commits.

Expected Outcome:

The repository should be fully open-source with the app initialized, and all necessary files, templates, and labels should be added. This will create a structured and collaborative environment for contributors.

Additional context

No response

I would be willing to submit a PR to fix this issue

github-actions[bot] commented 3 weeks ago

Thanks for the issue, our team will look into it as soon as possible! If you would like to work on this issue, please wait for us to decide if it's ready. The issue will be ready to work on once we remove the "needs triage" label.

To claim an issue that does not have the "needs triage" label, please leave a comment that says ".take". If you have any questions, please reach out to us on Discord or follow up on the issue itself.

For full info on how to contribute, please check out our contributors guide.

monacodelisa commented 2 weeks ago

https://github.com/Shared-IDE/free-editor/commit/6833a1870ef574b66085622498ce45418b1dd7af