Loop Language Development Guidelines

[WouterPennings]

Loop Language Development Guidelines

Website | Documentation | Discord | Jira Board

Below you will find all the rules, conventions and guidelines on how we develop software for Loop. These are needed for greater work efficiency and to create the best software possible.

Issues

• Use Jira to create: tasks, bug and stories.
  • When you create issue on Jira, try to add it to a correlating Epic.
  • Epic: A body of work that can be broken down into smaller tasks (Story). Example: version 0.1.0
  • Story: Known as "user story" are a list or requirements that make up an Epic. Example: implement string type.
  • Task: Small jobs, mostly done by an individual. Multiple tasks make up a story.
  • Bug: Unwanted/unexpected behavior of software that needs to be fixed.
• Give a clear description of the issue, this will save hassle later on.

Pull Requests (PR)

• Give clear and semantic names to your branches.
  1. It needs to start with the id of the issue in Jira. Examples: LOOP-44 or LOOP-3.
  2. After the id, you need to give it as short as possible name that is descriptive.
  3. Examples: LOOP-3-enums or LOOP-77-implement-inkwell.
• To merge the PR, you need approval from at least the project lead, and @kanersps or @WouterPennings
• Tests are required, otherwise the PR will be denied. We do not want untested/unproven code in our software.

Committing

• Commit messages need to have Conventional Commits.
• Never commit to main, always to a separate branch.

Extra

• All the repositories are MIT licensed.
• All the software needs to have semantic versioning.
• Git repository names need to be simple and only lower case.
• Does not apply if you are a open-source contributor: The sprints are three weeks of length.

Go to the website for more information.