Help

Welcome to the Help page! Whether you’re troubleshooting, reporting a bug, or seeking advice, this documentation is the place to find guidance.

If you need help with any aspect of Nomage, let us know! We would be happy to hear from you.

Finding Information

Start by exploring this documentation, which covers:

• Getting started
  • Installation: Detailed steps to get the project running smoothly.
  • Python API: Start with a quick overview of the Python API.
  • CLI: Introduction to the command-line interface.
• Learn
  • Built-in conventions: The full list of supported built-in naming conventions.
  • Usage
    • Detection: Learn how to detect the convention used by an identifier.
    • Check / Assertion: Check if an identifier match a given convention.
    • Conversion / Transform: Learn how to convert from one convention to the other.
  • Advanced usage
    • Custom convention: Learn to create custom naming convention with the API for your specific use-cases.
• API Reference: Extensive documentation of the Python API.

If the documentation doesn’t answer your question, don’t worry—there are more ways to get help!

Issues / Bug Tracker

You can find in the Contributing page the details on how to contribute.

Troubleshooting Tips

Here are some tips to help troubleshoot issues effectively:

• Simplify the Problem: Reduce your code to the smallest example that reproduces the issue.
• Check Dependencies: Ensure all required libraries and tools are up to date.
• Version Compatibility: Verify compatibility between different versions of dependencies.

Watch the GitHub repository for releases

You can "watch" Nomage in GitHub (by clicking the "watch" button at the top right): https://github.com/CGuichard/nomage. Select "Releases only" to receive notifications whenever there's a new release. A release content is always detailed, so that you may know what's new.

Helping us?

Star Nomage in GitHub

You can "star" our repository in GitHub (by clicking the star button at the top right): https://github.com/CGuichard/nomage. By adding a star you help Nomage gain more visibility, so that other users will be able to find it more easily and see that it has been already useful for others.

Want to contribute?

We welcome everyone wishing to contribute. If you are interested, go check the Contributing section.