Add project and package naming guidelines
phxnsharp opened this issue · comments
📝 Description of the feature
Per ansys/pyansys-tools-variableinterop#115 there are a set of standard naming rules that projects tend to follow. This should be documented to make it easier to follow.
Maybe this exists and I didn't find it?
💡 Steps for implementing the feature
- write documentation on naming guidelines
- ...
- Profit
🔗 Useful links and references
No response
Thanks for opening this, @phxnsharp. This is something we need to update in the guide. Right now, it only covers the case for naming a project that wraps an Ansys product.
From what is being implemented in #236, we recognize at least three types of projects:
- Documentation projects
- Tools projects
- Library projects
We must document the naming conventions for each one.