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

Add project and package naming guidelines #238

Open
phxnsharp opened this issue Jan 11, 2023 · 1 comment
Open

Add project and package naming guidelines #238

phxnsharp opened this issue Jan 11, 2023 · 1 comment
Labels
enhancement New features or code improvements

Comments

@phxnsharp
Copy link

📝 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

  1. write documentation on naming guidelines
  2. ...
  3. Profit

🔗 Useful links and references

No response

@phxnsharp phxnsharp added the enhancement New features or code improvements label Jan 11, 2023
@jorgepiloto
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

No branches or pull requests

2 participants