WIP: Create initial template.

scott commented

2023-09-01 10:12:48 +00:00

Owner

No description provided.

scott added 2 commits 2023-09-01 10:12:49 +00:00

Update README a4e4ee477b

Create empty .gitignore file 517503cec3

scott force-pushed repo-init from 517503cec3 to a31d484949

2023-09-01 10:21:28 +00:00

Compare

evanb commented

2023-09-01 17:52:59 +00:00

Member

Ok I am of two mind sets with this...

A. For and initial getting started point, it gets you off the ground. Sure approve and move forward.

B. If this is a template to be used on project creation, all of this should go and it should be only template headers and not so instruction based

(I made this up on the fly with no thought)
README.md:

# PROJECT NAME
a description of the project

### Requirements
list what software is required to run the project

### Documentation
point to were one can find documentation, whether the wiki, or doc/ directory

## Getting setup
describe how to set up the project for local development

Ok I am of two mind sets with this... A. For and initial getting started point, it gets you off the ground. Sure approve and move forward. B. If this is a template to be used on project creation, all of this should go and it should be only template headers and not so instruction based (I made this up on the fly with no thought) README.md: ``` # PROJECT NAME a description of the project ### Requirements list what software is required to run the project ### Documentation point to were one can find documentation, whether the wiki, or doc/ directory ## Getting setup describe how to set up the project for local development ```

👍 1

scott added 1 commit 2023-09-02 13:53:30 +00:00

Try again 655031dfdd

scott changed title from ~~Create initial template.~~ to WIP: Create initial template.

2023-09-02 13:54:47 +00:00

scott commented

2023-09-02 13:56:33 +00:00

Author

Owner

The more I try to work on this the more the whole thing feels like a futile effort, largely because in most cases the language tooling that we're working with will build out this sort of scaffolding for us in most cases. I was trying to combine the idea you had there with the README generated by crystal init, you can see what I have so far in the most recent commit. If we bother with keeping this repo around I'm going to squash the commits.

There is a possibility that variable substitution may work here, which would be nice, occasionally, but I think it may be a better idea to focus on documenting smaller tasks as we do them than to try to seed some vast wiki of documentation that won't be all that useful anyway.

The more I try to work on this the more the whole thing feels like a futile effort, largely because in most cases the language tooling that we're working with will build out this sort of scaffolding for us in most cases. I was trying to combine the idea you had there with the README generated by `crystal init`, you can see what I have so far in the most recent commit. If we bother with keeping this repo around I'm going to squash the commits. There is a possibility that [variable substitution](https://docs.gitea.com/usage/template-repositories) may work here, which would be nice, occasionally, but I think it may be a better idea to focus on documenting smaller tasks as we do them than to try to seed some vast wiki of documentation that won't be all that useful anyway.

This pull request is marked as a work in progress.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin repo-init:repo-init

git checkout repo-init

Merge

Merge the changes and update on Forgejo.

git checkout main

git merge --no-ff repo-init

git checkout main

git merge --ff-only repo-init

git checkout repo-init

git rebase main

git checkout main

git merge --no-ff repo-init

git checkout main

git merge --squash repo-init

git checkout main

git merge --ff-only repo-init

git checkout main

git merge repo-init

git push origin main

WIP: Create initial template. #2

Checkout

Merge