Skip to content

Commit

Permalink
ENH: added template instructions
Browse files Browse the repository at this point in the history
Created a document that includes instructions for using this template package.
  • Loading branch information
aburrell committed Sep 14, 2023
1 parent 71428b6 commit 216e058
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
This repository provides a template for creating a pysat Ecosystem package. The
files within are all examples for the GitHub community standards, continuous
integration, PyPi support, documentation, and basic installation documents
needed for a pysat Ecosystem package. Adhering to these standards is not
required, but will assist in package maintenance.

In all of these documents, PACKAGENAME is used in place of the pysat Ecosystem
package name. Please proof read each document carefully before applying it and
consider submitting changes and improvements to these templates as Issues or
Pull Requests to this repository.

Contents
========

Community Documents
-------------------

* README.md
* CODE_OF_CONDUCT.md
* CONTRIBUTING.md
* LICENSE
* .gitignore
* .github/pull_request_template.md
* .github/ISSUE_TEMPLATE/bug_report.md
* .github/ISSUE_TEMPLATE/feature_request.md
* .github/ISSUE_TEMPLATE/question.md

Continuous Integration
----------------------

* .github/workflows/docs.yml
* .github/workflows/main.yml
* .github/workflows/pip_rc_install.yml
* .github/workflows/pysat_rc.yml

Documentation
-------------

* .readthedocs.yml
* docs/Makefile
* docs/conf.py
* docs/figures/packagename_logo.jpg

Installation/Python Basics
--------------------------

* MANIFEST.in
* pyproject.toml
* requirements.txt
* setup.cfg
* test_requirements.txt
* PACKAGENAME/__init__.py

0 comments on commit 216e058

Please sign in to comment.