micronaut-projects / micronaut-projects/micronaut-http-benchmarks

micronaut-http-benchmarks new module checklist

Open
#2 3 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Steps
- [x] Use [Project template](https://github.com/micronaut-projects/micronaut-project-template) to create a new repository.
- [x] Prefix the repository with `micronaut-`.
- [ ] Add the [project to file sync](https://github.com/micronaut-projects/micronaut-project-template/blob/master/.github/workflows/files-sync.yml#L14) without the `micronaut-` prefix.
- [ ] Add the module to [management](https://github.com/micronaut-projects/management/blob/master/repos.auto.tfvars) repository.
Ping @graeme or @sdelamo about it.
- [ ] Request a [Sonar Cloud](https://sonarcloud.io/organizations/micronaut-projects) admin to add the new project, and disable Automatic Analysis. Ping @sdelamo about it.
![Disable Automatic Analysis in the project administration in Sonar Cloud](https://user-images.githubusercontent.com/864788/163421196-2b692f60-2122-43e3-9509-cd53c6d6f455.png)
- [ ] Set Long Lived Branches pattern to `\d+\.\d+\.x`
![SonarCloud Long Lived Branches pattern](https://github.com/micronaut-projects/micronaut-core/assets/864788/a9dc9f29-8ebb-4bad-b8cb-8986d16dd117)
- [ ] Add module to https://github.com/micronaut-projects/micronaut-docs-index/blob/main/modules.yml

### Splitting a module out of core to its own repo

Here are the steps followed when we created [micronaut-session](https://github.com/micronaut-projects/micronaut-session)

https://docs.github.com/en/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository

Step by step; (**Replace** `micronaut-session` for your new module name, and `session` as your sub-project of interest)

1. Install `git-filter-repo`
```
brew install git-filter-repo
```
2. Clone the branch of core you're interested in extracting from
```
git clone https://github.com/micronaut-projects/micronaut-core.git -b 4.0.x micronaut-session
```
3. go into the new directory
```
cd micronaut-session
```
4. Filter the repo to remove anything non-session related
```
git filter-repo --path session/
```
5. Rename the branch to master
```
git branch -m master
```
6. Strip all the tags
```
git tag -d $(git tag -l)
```
7. Strip all the branches
```
git branch | grep -v "master" | xargs git branch -D
```
8. Create a new public project on GitHub under `micronaut-projects` called `micronaut-session`
9. Add a remote pointing to this new repo
```
git remote add origin https://github.com/micronaut-projects/micronaut-session.git
```
10. From a local recent clone of https://github.com/micronaut-projects/micronaut-project-template, copy all the files into the current folder.
11. Fix them up with your project name, as per normal
12. Push
```
git push origin master
```

You will need to copy docs from `core/src` to your new repo.

Then follow the steps above

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.