Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting project decisions #29

Closed
yasharpm opened this issue Jan 5, 2023 · 2 comments
Closed

Documenting project decisions #29

yasharpm opened this issue Jan 5, 2023 · 2 comments

Comments

@yasharpm
Copy link
Contributor

yasharpm commented Jan 5, 2023

I think in a meeting with @michielbdejong we agreed to record the project decisions in a documents folder next to project files. I feel proud to have put the laravel project in a subfolder when I pushed the initial code!

I think a "doc" or "documents" folder on the root of the repository makes a good fit. And we will need to move the Structure.md and other relevant files into that folder as well.

Then whenever we make a conclusion about a decision like Issue 28, we can include it in that document.

I have no idea for the format to write them down. Like many files or one file or maybe a folder structure. Personally, I think we can start with whatever and then see how we can organize them after we have a bunch of them there.

Also, seems like a good idea that the person who created the issue (or closes it?) will make sure it is documented.

What do you think?

@mlesmenio
Copy link
Contributor

This makes sense. I would start with 1 doc folder and 1 file in it and hope that at some point it will make sense to split it into more files. I would say to check if the issue is documented upon closing so that it has a comment like "closed because of [link]".

@yasharpm
Copy link
Contributor Author

yasharpm commented Jan 5, 2023

I guess it's decided then!

@yasharpm yasharpm closed this as completed Jan 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants