https://github.com/uibcdf/developer-guidelines

Guidelines for developers of Python scientific libraries, GitHub Actions, and other open-source software at the UIBCDF.
https://github.com/uibcdf/developer-guidelines

guidelines template-project template-repository

Last synced: 2 months ago
JSON representation

Guidelines for developers of Python scientific libraries, GitHub Actions, and other open-source software at the UIBCDF.

• Host: GitHub
• URL: https://github.com/uibcdf/developer-guidelines
• Owner: uibcdf
• License: other
• Created: 2021-06-29T22:12:45.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-02-09T18:38:36.000Z (over 3 years ago)
• Last Synced: 2025-01-23T03:14:17.023Z (4 months ago)
• Topics: guidelines, template-project, template-repository
• Language: Python
• Homepage: http://www.uibcdf.org/Developer-Guidelines/
• Size: 257 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# UIBCDF Developers' Guidelines

## Python projects

In [the UIBCDF GitHub repository called "Python-Projects-Template"](https://github.com/uibcdf/Python-Projects-Template) you

can find the guidelines and template to develope a scientific Python library according to the

UIBCDF style and structure. Following this instructions will save time if you are an experienced

developer, or will guide your first steps if you are a newbiew.

Its documentation covers the following issues:

- MolSSI Cookie-cutter as starting point.

- Project structure.

- Documentation.

- Testing.

- Conda deployment in the UIBCDF channel.

All libraries developed in the UIBCDF follow these guidelines. Here you have some examples:

- MolSysMT

- Sabueso

## Github Actions

...

## Sphinx themes

...

## Open source guidelines

...

## License

UIBCDF Developers' Guidelines by the contributors of the uibcdf/Developer-Guidelines GitHub repository is licensed under CC BY-NC-SA 4.0


[A copy of the CC Attribution-NonCommercial-ShareAlike 4.0 International license's legal code is included in this

repository](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.txt).