Skip to content

Template repository for scaffolding new Athena components

License

Notifications You must be signed in to change notification settings

athena-framework/component-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Template repo for creating a new Athena component. Scaffolds the Crystal shard's structure as well as define CI etc.

NOTE: This repo assumes the component will be in the athena-framework org. If it is to be used outside of the org, be sure to update URLs accordingly.

  1. Find/replace COMPONENT_NAME with the name of the component. This is used as the shard's name. E.x. logger. 1.1 Be sure to rename the file in ./src, and ./spec as well.

  2. Replace NAMESPACE_NAME with the name of the component's namespace. Documentation for this component will be grouped under this. E.x. Logger.

  3. Find/replace CREATOR_NAME with your Github display name. E.x. George Dietrich.

  4. Find/replace CREATOR_USERNAME with your Github username. E.x. blacksmoke16.

  5. Find/replace CREATOR_EMAIL with your desired email

    5.1 Can remove this if you don't wish to expose an email.

  6. Find/replace ALIAS_NAME with the three letter alias for this component; A + 2 letter shortcut to NAMESPACE_NAME. E.x. ALG.

  7. Find/replace DESCRIPTION with a short description of what the component does.

Delete from here up

NAMESPACE_NAME

Common Changelog CI Latest release

DESCRIPTION.

Getting Started

Checkout the Documentation.

Contributing

Read the general Contributing Guide for information on how to get started.

About

Template repository for scaffolding new Athena components

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published