Skip to content

Commit

Permalink
refactor(core): change name of project to tasks (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
luismayta committed Dec 27, 2024
1 parent 33a46f3 commit 1741079
Show file tree
Hide file tree
Showing 23 changed files with 1,785 additions and 1,470 deletions.
2 changes: 1 addition & 1 deletion .chglog/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ style: github
template: CHANGELOG.tpl.md
info:
title: CHANGELOG
repository_url: https://github.com/hadenlabs/base-template
repository_url: https://github.com/hadenlabs/tasks
options:
commits:
filters:
Expand Down
6 changes: 3 additions & 3 deletions .ci/linters/.goreleaser.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# This is an example goreleaser.yaml file with some sane defaults.
# Make sure to check the documentation at http://goreleaser.com
project_name: base-template
project_name: tasks
env:
- GO111MODULE=on
- REPO=github.com/hadenlabs/base-template
- REPO=github.com/hadenlabs/tasks
before:
hooks:
- go mod download
Expand Down Expand Up @@ -67,7 +67,7 @@ changelog:
release:
github:
owner: hadenlabs
name: base-template
name: tasks
draft: true
prerelease: auto
name_template: "{{.ProjectName}}-v{{.Version}}-{{.ShortCommit}}-{{.Date}}"
2 changes: 1 addition & 1 deletion .ci/linters/markdown-link-config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"baseUrl": "https://github.com/hadenlabs/base-template",
"baseUrl": "https://github.com/hadenlabs/tasks",
"ignorePatterns": [
{
"pattern": "^https://hadenlabs.com"
Expand Down
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **NOTE**: please check the following document docs/env-vars.md
APP_NAME=base-template
APP_NAME=tasks
SONAR_URL=
SONAR_TOKEN=
6 changes: 3 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ ci:
autoupdate_schedule: monthly

default_stages:
- commit
- pre-commit
exclude: >
(?x)^(
^(\/|)vendor\/(.*?)$|
Expand Down Expand Up @@ -30,15 +30,15 @@ repos:
go.sum|
)$
- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v9.16.0
rev: v9.19.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ["@hadenlabs/commitlint-config"]
args:
- --config=.ci/linters/.commitlintrc.json
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: detect-private-key
files: ^(?!\.?git-crypt)
Expand Down
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
-->

[![Latest Release](https://img.shields.io/github/release/hadenlabs/base-template)](https://github.com/hadenlabs/base-template/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/base-template/lint-code)](https://github.com/hadenlabs/base-template/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/hadenlabs/base-template/ci)](https://github.com/hadenlabs/base-template/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/hadenlabs/base-template/test)](https://github.com/hadenlabs/base-template/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-orange)](https://keepachangelog.com)
[![Latest Release](https://img.shields.io/github/release/hadenlabs/tasks)](https://github.com/hadenlabs/tasks/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/tasks/lint-code)](https://github.com/hadenlabs/tasks/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/hadenlabs/tasks/ci)](https://github.com/hadenlabs/tasks/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/hadenlabs/tasks/test)](https://github.com/hadenlabs/tasks/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-orange)](https://keepachangelog.com)

# base-template
# tasks

base-template for project
tasks for project

## Requirements

Expand All @@ -30,17 +30,11 @@ This is a list of plugins that need to be installed previously to enjoy all the

# How to use this project

## Replace name project to New Project

```bash
agr 'base-template' 'new-project'
```

## Examples

<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Examples BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Examples Tasks -->
<!-- Label: Examples -->
<!-- Include: ./../disclaimer.md -->
<!-- Include: ac:toc -->
Expand All @@ -51,7 +45,7 @@ agr 'base-template' 'new-project'

**Got a question?**

File a GitHub [issue](https://github.com/hadenlabs/base-template/issues).
File a GitHub [issue](https://github.com/hadenlabs/tasks/issues).

## Contributing

Expand All @@ -74,7 +68,7 @@ Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following co

## Copyright

Copyright © 2018-2023 [Hadenlabs](https://hadenlabs.com)
Copyright © 2018-2024 [Hadenlabs](https://hadenlabs.com)

## Trademarks

Expand All @@ -84,6 +78,6 @@ All other trademarks referenced herein are the property of their respective owne

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like base-template
## Don't forget to 🌟 Star 🌟 the repo if you like tasks

[Your feedback is appreciated](https://github.com/hadenlabs/base-template/issues)
[Your feedback is appreciated](https://github.com/hadenlabs/tasks/issues)
10 changes: 5 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Security BaseTemplate -->
<!-- Label: BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Security Tasks -->
<!-- Label: Tasks -->
<!-- Label: Security -->
<!-- Include: docs/disclaimer.md -->
<!-- Include: ac:toc -->
Expand All @@ -10,6 +10,6 @@

## Reporting a Security Bug

If you think you have discovered a security issue in any of the base-template projects, we'd love to hear from you. We will take all security bugs seriously and if confirmed upon investigation we will patch it within a reasonable amount of time and release a public security bulletin discussing the impact and credit the discoverer.
If you think you have discovered a security issue in any of the tasks projects, we'd love to hear from you. We will take all security bugs seriously and if confirmed upon investigation we will patch it within a reasonable amount of time and release a public security bulletin discussing the impact and credit the discoverer.

There are two ways to report a security bug. The easiest is to email a description of the flaw and any related information (e.g. reproduction steps, version) to [security at base-template dot org](mailto:[email protected]).
There are two ways to report a security bug. The easiest is to email a description of the flaw and any related information (e.g. reproduction steps, version) to [security at tasks dot org](mailto:[email protected]).
2 changes: 1 addition & 1 deletion Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ dotenv:
- .env

vars:
PROJECT_NAME: base-template
PROJECT_NAME: tasks
ORGANIZATION: hadenlabs
DOCKER_PLATFORM: linux/amd64
REVIEWERS: luismayta
Expand Down
6 changes: 3 additions & 3 deletions docs/commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Commands BaseTemplate -->
<!-- Label: BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Commands Tasks -->
<!-- Label: Tasks -->
<!-- Label: Project -->
<!-- Label: Commands -->
<!-- Include: disclaimer.md -->
Expand Down
6 changes: 3 additions & 3 deletions docs/components.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Components BaseTemplate -->
<!-- Label: BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Components Tasks -->
<!-- Label: Tasks -->
<!-- Label: Project -->
<!-- Label: Components -->
<!-- Include: disclaimer.md -->
Expand Down
18 changes: 9 additions & 9 deletions docs/contribute/github-flow.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Contributing GithubFlow BaseTemplate -->
<!-- Label: BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Contributing GithubFlow Tasks -->
<!-- Label: Tasks -->
<!-- Label: Project -->
<!-- Label: Contributing -->
<!-- Label: GithubFlow -->
<!-- Include: ./../disclaimer.md -->
<!-- Include: ac:toc -->

To contribute to base-template project on [GitHub](https://github.com/hadenlabs/base-template), We use [GitHub Flow](https://githubflow.github.io/), it means that you should branch from the main repository and contribute back by making [pull request](https://github.com/hadenlabs/base-template/pulls).
To contribute to tasks project on [GitHub](https://github.com/hadenlabs/tasks), We use [GitHub Flow](https://githubflow.github.io/), it means that you should branch from the main repository and contribute back by making [pull request](https://github.com/hadenlabs/tasks/pulls).

GitHub Flow is very lightweight (especially compared to GitFlow). This workflow uses only two kinds of branches:

Expand All @@ -23,18 +23,18 @@ For more information see [GitHub Flow](https://githubflow.github.io/)

## Getting started

To follow the instructions in this guide and start contributing to base-template project on GitHub:
To follow the instructions in this guide and start contributing to tasks project on GitHub:

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine

To synchronize with the main repository, add it to the remotes:

```bash
git remote add upstream https://github.com/hadenlabs/base-template.git
git remote add upstream https://github.com/hadenlabs/tasks.git
```

Now your **upstream** points to **hadenlabs/base-template**.
Now your **upstream** points to **hadenlabs/tasks**.

## Branches

Expand All @@ -58,7 +58,7 @@ To resolve a conflict, run the following commands.

```bash
# checkout a branch you open PR from
git fetch upstream # assuming upstream is hadenlabs/base-template
git fetch upstream # assuming upstream is hadenlabs/tasks
git merge upstream/merge_branch # Where merge_branch is a branch you open merge request against.
# resolve merge requests
git add changed_files
Expand All @@ -70,7 +70,7 @@ Github will automatically update your pull request.

### Testing

All merge requests are automatically tested using [Github Actions](https://github.com/hadenlabs/base-template/actions). In case some tests fail, fix the issues or describe why the fix cannot be done.
All merge requests are automatically tested using [Github Actions](https://github.com/hadenlabs/tasks/actions). In case some tests fail, fix the issues or describe why the fix cannot be done.

### Review

Expand Down
18 changes: 9 additions & 9 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Contributing BaseTemplate -->
<!-- Label: BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Contributing Tasks -->
<!-- Label: Tasks -->
<!-- Label: Contributing -->
<!-- Include: disclaimer.md -->
<!-- Include: ac:toc -->

# How To Contribute

Contributions to base-template are welcome.
Contributions to tasks are welcome.

Feel free to use all of the contribution options:

- Contribute to base-template repositories on [GitHub](https://github.com/hadenlabs/base-template). See [Git flow](./contribute/github-flow.md).
- Contribute to tasks repositories on [GitHub](https://github.com/hadenlabs/tasks). See [Git flow](./contribute/github-flow.md).

## Getting Started

Expand Down Expand Up @@ -73,23 +73,23 @@ See [Git flow](./contribute/github-flow.md).

### Documentation

Documentation is a part of the base-template code base. You can find the documentation files in the `doc/` subdirectory of the [main repository](https://github.com/hadenlabs/base-template). This means that the contribution process is the same for both the source code and documentation.
Documentation is a part of the tasks code base. You can find the documentation files in the `doc/` subdirectory of the [main repository](https://github.com/hadenlabs/tasks). This means that the contribution process is the same for both the source code and documentation.

### Testing

See [Testing](./testing.md).

### Code Submission

1. See if a [Pull Request](https://github.com/hadenlabs/base-template/pulls) exists
1. See if a [Pull Request](https://github.com/hadenlabs/tasks/pulls) exists
- Add some comments or review the code to help it along
- Don\'t be afraid to comment when logic needs clarification
2. Create a Fork and open a [Pull Request](https://github.com/hadenlabs/base-template/pulls) if needed
2. Create a Fork and open a [Pull Request](https://github.com/hadenlabs/tasks/pulls) if needed

### Code Review

- Anyone can review code
- Any [Pull Request](https://github.com/hadenlabs/base-template/pulls) should be closed or merged within a week
- Any [Pull Request](https://github.com/hadenlabs/tasks/pulls) should be closed or merged within a week

### Code Acceptance

Expand Down
6 changes: 3 additions & 3 deletions docs/env-vars.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: EnvVars BaseTemplate -->
<!-- Label: BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: EnvVars Tasks -->
<!-- Label: Tasks -->
<!-- Label: Project -->
<!-- Label: EnvVars -->
<!-- Include: disclaimer.md -->
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/common.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Examples BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Examples Tasks -->
<!-- Label: Examples -->
<!-- Include: ./../disclaimer.md -->
<!-- Include: ac:toc -->
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Welcome to base-template documentation
# Welcome to tasks documentation
8 changes: 4 additions & 4 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Releasing BaseTemplate -->
<!-- Label: BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Releasing Tasks -->
<!-- Label: Tasks -->
<!-- Label: Project -->
<!-- Label: Releasing -->
<!-- Include: disclaimer.md -->
Expand All @@ -11,7 +11,7 @@

## Bump a new version

Make a new version of base-template in the following steps:
Make a new version of tasks in the following steps:

### Generate version major

Expand Down
6 changes: 3 additions & 3 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Space: Projects -->
<!-- Parent: BaseTemplate -->
<!-- Title: Roadmap BaseTemplate -->
<!-- Parent: Tasks -->
<!-- Title: Roadmap Tasks -->
<!-- Label: Roadmap -->
<!-- Include: disclaimer.md -->
<!-- Include: ac:toc -->
Expand Down Expand Up @@ -29,7 +29,7 @@

The Roadmap is a list of all the things we're working on for the year.

You can see the corresponding projects on [base-template](https://github.com/hadenlabs/base-template)
You can see the corresponding projects on [tasks](https://github.com/hadenlabs/tasks)

## Legend

Expand Down
6 changes: 0 additions & 6 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1 @@
# How to use this project

## Replace name project to New Project

```bash
agr 'base-template' 'new-project'
```
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: base-template Documentation
site_name: tasks Documentation
theme: "material"
markdown_extensions:
- toc:
Expand All @@ -15,8 +15,8 @@ extra:
font:
text: "Source Sans Pro"

repo_name: "hadenlabs/base-template"
repo_url: "https://github.com/hadenlabs/base-template"
repo_name: "hadenlabs/tasks"
repo_url: "https://github.com/hadenlabs/tasks"
copyright: 'Copyright © 2021 <a href="https://hadenlabs.com">hadenlabs</a>'

google_analytics:
Expand Down
Loading

0 comments on commit 1741079

Please sign in to comment.