atomneb / atomneb-idl Goto Github PK

Although each function in AtomNeb-idl has a docstring describing its functionality, it's a best practice to create separate API documentation for a package. This makes it easier for developers (and users) to understand what each routine in the package does.

A recommendation: IDLdoc produces nice API documentation, and it's an accepted standard in the IDL community.

The repo should be stamped with a version number (e.g., in AtomNeb-idl/releases) for public release.

Unit tests, written by the developer, are extremely helpful for ensuring that software behaves as a developer intends. (I've caught so many defects through unit tests.) Unit tests should be added to this package.

IDL's path management can be difficult, especially for a newcomer. It would be helpful to add a short note to the README about how to install this package. For example:

Installation

To install the AtomNeb database and API library on your machine, simply add this directory to your IDL path. If you're new to IDL, learn more about path management in this article from Harris Geospatial Solutions, or in this article by David Fanning of the Coyote IDL Library.

Information should be provided to direct users how to contribute, report problems, or seek help when working with this software.

For example, astropy has a CONTRIBUTING.md file that provides this information. A (far shorter!) version of such a file be appropriate here.