-
Notifications
You must be signed in to change notification settings - Fork 2
Repository contents
This file is used to make the GitHub repository citeable and contains information on the authors, title, version.
For more information:
- https://the-turing-way.netlify.app/communication/citable/citable-cff.html
- https://citation-file-format.github.io/
- https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
In order to create a Python package that is installable through pip, we require the following files:
- init.py in the package folder
- setup.cfg contains the package metadata, dependencies, and installation options
- pyproject.toml defines what build tools are needed to build the package.
- MANIFEST to list all additional files to need to be added to the package (Readme, license)
For more information:
Uploading the package to PyPI
Configuration file for the tool bump2version. This tool is used to update all mentions of the version number when creating a new release. The version number follows semantic versioning.
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards compatible manner, and
PATCH version when you make backwards compatible bug fixes.
To release a new functionality, you can update the version number with
bump2version minorThe open science community has developed a set of community standards. Among these are the following files
- CHANGELOG.md describing the changes between releases
- README.md with essential information about the project and how to get started
- CONTRIBUTION.md describing the preferred way of developers to contribute to the project together with a description for releasing new versions
- CODE_OF_CONDUCT.md
GitHub also tracks the presence of these files (in the master branch). For this repository, you can look at https://github.com/koenderinklab/ddmPilotCode/community for more info.