Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.37 KB

File metadata and controls

29 lines (22 loc) · 1.37 KB

Agents

Main directive

Everything is a work in progress and can be updated and improved. If you find a problem, fix it if it's small; otherwise, register it as an issue in the respective repo.

Install the ecosystem

  1. Create a folder in the home directory called .msx:
  2. Clone the ecosystem locally:
    1. https://github.com/MSXOrg/docs — requires PRs to be updated.
      • Clone as bare and use worktrees.
      • Create a worktree for all branches - worktree = name of the branch.
    2. https://github.com/MSXOrg/memory/ — work directly towards main.
      • Simple clone, only main.

To install:

  • Clone the repos in the users home folder under a sub-folder named .msx.
  • Set configs locally to each of these repos using the GitHub username and email.

Working with the ecosystem

  1. Get to know this repo first:
    • README for what this repository is and how it builds.
    • CONTRIBUTING for how to contribute and the review process.
  2. Read the .msx/main/docs - start with the index to get an overview of what is here.
  3. Read the .msx/memory - start with the index to get an overview of what is here. Use this while working - commit your memories here for work inside the PSModule organization.
  4. While working with the code, do small micro commits and push on every commit. This will make it easier to review and merge your changes.