Add new_projects.md #14

Merged
todtb merged 2 commits from todtb-patch-1 into main 2023-08-10 01:47:51 +00:00

12
new_projects.md Normal file
View file

@ -0,0 +1,12 @@
# New projects
## Initializing the repository
1) Create the repository on at `git.tams.tech/tws` first and clone
Outdated
Review

"and clone it"

"and clone it"
2) Push an empty commit to the `main` branch with the message 'init':
Outdated
Review

I don't think you can create an "empty commit". Perhaps one should do this?

touch .gitignore
git add .gitignore
git commit -m init
git push -u upstream main
I don't think you can create an "empty commit". Perhaps one should do this? ```console touch .gitignore git add .gitignore git commit -m init git push -u upstream main ```
`git commit --alow-empty -m 'init'`
Outdated
Review

I think more specific instructions are due here. Specifically, the process of changing a remote from origin to upstream after cloning it, adding your fork as a clone, checking out a branch named "prototype" and creating a PR for that.

I think more specific instructions are due here. Specifically, the process of changing a remote from origin to upstream after cloning it, adding your fork as a clone, checking out a branch named "prototype" and creating a PR for that.
Outdated
Review

So I just took some time and wrote up a step by step guide on how to create a new project based on this outline. I was wondering where the best place is to post it?

Should I fork and submit a PR from todtb-patch-1?
Create my own fork and PR into main?
Should we utilize the WIKI for documentation?

So I just took some time and wrote up a step by step guide on how to create a new project based on this outline. I was wondering where the best place is to post it? Should I fork and submit a PR from `todtb-patch-1`? Create my own fork and PR into `main`? Should we utilize the WIKI for documentation?
Outdated
Review

Create my own fork and PR into main?

Yeah, I guess it can't hurt to follow that practice even on the meta repo

Should we utilize the WIKI for documentation?

I like that idea! I think there's still value in the meta repo for documentation that doesn't apply strictly to a codebase, but I'm open to trying it out. I guess it could be the wiki on this repo too.

> Create my own fork and PR into main? Yeah, I guess it can't hurt to follow that practice even on the `meta` repo > Should we utilize the WIKI for documentation? I like that idea! I think there's still value in the `meta` repo for documentation that doesn't apply strictly to a codebase, but I'm open to trying it out. I guess it could be the wiki on this repo too.
Outdated
Review

I will PR for now but I too think there should be a place for random documentation. Something everyone can reference when they get started. Ill open an issue for discussion.

I will PR for now but I too think there should be a place for random documentation. Something everyone can reference when they get started. Ill open an issue for discussion.
3) All further work to be merged from a branch on a fork
1) Return to the web interface at `git.tams.tech/tws` and click the "fork" button
2) Clone your forked repo
3) Add the upstream (ex: `git remote add upstream ssh://git@git.tams.tech:2222/TWS/meta-tasks.git`)
4) You can then fetch upstream changes and merge them to your fork
5) Opening PRs should typically be from your fork's work branch to the upstream main