Best way to store general project notes/description?

When I need to record some information for a project—basically a note, e.g., “this is a test project I created for purpose X/Y”—what’s the best way to do it?

Yes, I can create a text file in the project folder and put it there, but is there any “official” way to store general information/notes within the project itself?

There is a Description field in a model’s package element. I think that’s the best place for such a description.

That is a description related to a particular package but what if I have several packages in my project and need notes that are related to all of them?
The description belongs to the application as a whole and I don´t want to store the same text in all the package descriptions neither search all of them to find the right one.
Is there any other solution?

Then it seems using a README file as the best approach. README.md in the root of repository tends to be automatically displayed in web interfaces.

1 Like

This topic was automatically closed 2 days after the last reply. New replies are no longer allowed.