Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .commitlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": ["@commitlint/config-conventional"],
"rules": {
"type-enum": [2, "always", ["build", "ci", "docs", "feat", "fix", "perf", "refactor", "style", "test"]]
}
}
120 changes: 0 additions & 120 deletions .eslintrc.json

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Please help us process issues more efficiently by filing an issue using one of the following templates:

https://github.com/tech4good-lab/causeway2/issues/new/choose

Thank you!
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Bug Report
description: Report a bug in your app

body:
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: A concise description of the bug you encountered.
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
placeholder:
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

- type: textarea
id: expected-behaviour
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.

- type: textarea
id: screenshots
attributes:
label: Add Screenshots or Recordings
description: Screenshots or recordings to explain your issue. If you can open the Developer Console so we can see any errors in the console, that would help.

- type: textarea
id: environment
attributes:
label: Please provide the environment you discovered this bug in
description: What device, OS, browser, and version?

- type: textarea
id: other
attributes:
label: Anything else?
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: 'Epic'
description: Track a larger feature or initiative that spans multiple issues

labels:
- "type: Epic"

body:
- type: input
id: title
attributes:
label: Epic Title
description: A short descriptive title for the epic.
placeholder: "Dark Mode"

- type: textarea
id: goal
attributes:
label: Goal
description: A clear, concise description of the outcome or feature this epic is meant to deliver.
placeholder: |
Add dark mode to the app so users can choose between light and dark themes.
validations:
required: true

- type: textarea
id: child-issues
attributes:
label: Child Issues
description: Link related issues here as a checklist.
placeholder: |
- [ ] #132 Dark mode scaffolding
- [ ] #133 Dark mode UI toggle
- [ ] #134 Dark mode user settings

- type: textarea
id: resources
attributes:
label: Related Resources
description: Add any design docs, PRDs, research notes, or external references.
placeholder: |
- Link to design doc
- Link to mockups
- Link to external references
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: 'Feature Request'
description: Suggest a feature for your app

body:
- type: textarea
id: description
attributes:
label: Description


- type: textarea
id: proposed-solution
attributes:
label: Proposed solution

- type: textarea
id: alternatives-considered
attributes:
label: Alternatives considered
61 changes: 61 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## PR Checklist
Please check if your PR fulfills the following requirements:

- [ ] The commit message follows our guidelines: https://github.com/tech4good-lab/causeway2/blob/develop/contributing-docs/commit-message.md
- [ ] If there is UI involved, the feature has been tested in multiple browsers and different window sizes
- [ ] Docs have been added / updated (for bug fixes / features)

#### Self-Review:
Please be honest with your review as this is part of your grade.

- [ ] There are no typos in your code or comments
- [ ] Variable names are meaningful and clear
- [ ] Variable names are in lower camel case (e.g. `userName`)
- [ ] HTML/SCSS class names are in kebab case (e.g. `learn-container`)
- [ ] Ensure code, **especially any generated by AI**, aligns with the repository’s coding standards as detailed in our [contributing docs](https://github.com/tech4good-lab/causeway2/blob/develop/contributing-docs/coding-standards.md)
- [ ] Docstring formatting should be specific for functions, variables, inputs, tests, and outputs
- [ ] Checks specifically for functions:
- [ ] Generally, add JSDoc tags (`@param {type} name - description`, `@returns`, etc.) where applicable
- [ ] For simple functions, include when it triggers and what it does
- [ ] For very complex components:
- Add a comment at the top explaining the purpose of the code
- Then also include inline comments to explain code (e.g. `// Set the focus and cursor on the new file`)
- [ ] Checks specifically for HTML:
- [ ] For complex views, have comments explaining the structure (e.g. `<!-- stackblitz output -->`)
- [ ] Ensure all the `.ts` organizational comments (e.g. INPUTS AND OUTPUTS, EVENT HANDLING, OTHER, etc.) are present
- [ ] Remove unused items:
- [ ] Imports on top of new files
- [ ] Variables
- [ ] Functions
- [ ] Old commented code
- [ ] empty `ngOnInit()` or `constructor()` methods
- [ ] Ensure `ng lint` has been run and that all issues have been fixed (best practice is to run it before each commit; please confirm this was done before you request a PR review)
- [ ] Run `ng build` and confirm the project compiles without errors
- [ ] Reaffirm that the PR title and commit messages follow our [commit message guidelines](https://github.com/tech4good-lab/causeway2/blob/develop/contributing-docs/commit-message.md)
- [ ] Include a scope for commit types that require it (e.g., `feat(main)`)
- [ ] Add a commit description in present tense
- [ ] Include the issue number in the branch name and PR description

## PR Type
What kind of change does this PR introduce?

- [ ] Bug fix
- [ ] New feature
- [ ] Code style update (formatting)
- [ ] Refactoring (no functional/api changes)
- [ ] Other... Please describe:

## What is the current behavior?

Issue Number: N/A

## What is the new behavior or feature being implemented?

## Does this PR introduce a breaking change?
A breaking change is a significant overhaul to the user interface that alters the user experience in ways users must adapt to, changes to ways data are stored that require data migration or could result in data loss, or removal of features users rely on. (If no initial version has been launched, i.e. still in version 0, then you can mark 'No')

- [ ] Yes
- [ ] No

## Other information
If appropriate, include screenshots and a router link for viewing your implemented feature
44 changes: 44 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Label definitions for PR autolabeling

# Core module changes
core:
- "src/app/core/**"

# Landing + onboarding flow
first-time:
- "src/app/first-time/**"

# Dashboard + notes and resources
"main":
- "src/app/main/**"


shared:
- "src/app/shared/**"

# Type of changes
docs:
- "contributing-docs/**"
- "**/*.md"
- "CODE_OF_CONDUCT.md"
- "CONTRIBUTING.md"
- "README.md"

styles:
- "styles/**"
- "**/*.scss"
- "**/*.css"

ci:
- ".github/**"

build:
- "package.json"
- "package-lock.json"
- "angular.json"
- "tsconfig.json"
- ".nvmrc"
- "scripts/**"

public:
- "public/**"
Loading
Loading