sekretone / hack-n-slack Goto Github PK

Add initial test suites.

💭 Test Now not Later

It is a misconception that tests slow down development. Contrary, they accelerate it. Incremental development should pair with incremental testing. Even a simple proof of concept should be able to have simple tests (to avoid simple bugs).

• configure node test
• establish any project patterns
• enforce high code coverage on total / diff

Considerations

• Linter perhaps can require tests to follow certain project patterns?

Enable branch protection of master, even for admins.

Purpose

Change control and ensure quality gates are met through a Pull Request. Enforce intent scoping of pull requests. A pull request template adds a norm for consistency for writing / reading, and expectations.

One should enforce such measures even on a solo project of any reasonable scale. Pushing scattered commits onto master.

• enable branch protection
• configure Pull Request Template

I want to create a simple map for 'player party' to navigate.

• ye start initializes map (or reinitialize)

• create a party entity to represent the players

• map of 10 rooms

• rooms are Cartesian (north south east west) connected.

• bot responds with a crude text map. An exposed section will show viable transitions

  ╔═ ═╗
  ║    
  ╚═══╝
  

• map navigates by commands ye go forward/back/left/right

Configure issue templates to choose from.

Purpose

Norm for describing intents so relevant details are captured. Expedites formatting. Pattern set for future automatically created issues.

The best tools are also teaching tools. Formally creating issues for even 'basic' config setup can help future developers, as personal norms may differ. Can also be used by the self to quickly audit and compare tooling.

Establish terms so similar issue elements are described the same way.

Examples

1. Purpose
   Why something should be done. Tone should be objective, but can include opinionated sentiments in a quote block.
2. Design
   List of 1 or more example. Psuedo code for high level concepts, but more technical precision if the issue is targeted or technically nuanced.
3. Expected
   How something was expected to behave
4. Actual
   How something actually behaved (crashed, differing behavior than described).
5. Do
   Check list of things needed to be completed (ie acceptance criteria)
6. Don't
   Check list of 0 or more things that must not happen, to clarify scope or call out a pitfall.

Do

• Add enhancement template
• Add component template
• Add technical template
• Add workflow template
• Add bug template
• All template issues include at least 1 label

Configure Pull request template

Purpose

Normalize pull request format. Could make compiling release notes systematic.

consider the default format: #10 (comment)

Design

Should be a simple enough process.

1. Summary
2. Release notes section that can be possibly processed when creating a release?

Do

• pull requests open with standard format
• has release notes

Setup automatic analysis to cloudsonar.io for coverage and quality.

Purpose

Systematically catch and resolve quality, bugs and security issues. Preemptive measures to reduce tech debt and enforce consistent behaviors.

Systematic quality gates establish a stable base. Testing and quality is a habit formed at the beginning, and not an afterthought.

Do

• create sonar project and register
• integrate keys/tokens
• integrate into pull request process
• configure branch protection to require status checks passed

Add an interpreter to use synonym detection on the commands.

• implement synonyms
• synonyms use ? to note as a valid token
• parentheses mark targets
• use a decorator pattern to mark @ye()

ye ?go ?forward
ye ?attack (entity)

Add a simple room class to store the context of the scene.

{
  entities: [
    { type: "creature" },
    { type: "prop" },
  ]
}

Add a persistence mechanism

Purpose

Games should save and serialize. If the bot is stopped the game should not be lost.

This would also be necessary to save and switch the active game being hosted by the bot in a channel.

Design

Considering a short term solution using node's fs to just save and write json.

Game data I think needs to be keyed off of server.id, while the active game is tracked under server.channel. I think the bot should maintain a single session at a time, but if a game is saved and stopped you can then switch which channel it's started back up in.

Do

• active game saves after each change
• active game can be stopped ye quit
• stopped game can be started up
• session tracks for the channel it was started in ye start

Party contains the player information.

• hold a list of players
• JSON serializable / deserializable
• list of all characters in the party
• use getters and setters

class Party{
  name: 'string'

  characters: [
    {
      name: 'string'
    }
  ]

  get players();
}

Create projects to track progress and group elements.

❓ I am unsure if Milestones are better than projects for certain feature trackings.

Purpose

Organize work in a searchable way. Establish scope of effort and its significance.

Often elements like workflow management, tech debt cleanup, etc do not get the attention they need, nor recognition when accomplished despite how essential it is.