Skip to content

Commit

Permalink
Documentation improvements (duartegroup#205)
Browse files Browse the repository at this point in the history
* Dev doc improvements

* Adds PR/issue templates
  • Loading branch information
t-young31 committed Dec 10, 2022
1 parent ab7c768 commit e2b90c0
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Feature request
about: Request a feature to be added
title: ''
labels: ''
assignees: ''

---

**Describe the feature**
<!-- A clear and concise description of what the feature is. -->
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--
Please replace _#ISSUE_ with just e.g. #12 if this PR resolves issue 12.
-->
## Resolves _#ISSUE_


***

## Checklist

* [ ] The changes include an associated explanation of how/why
* [ ] Test pass
* [ ] Documentation has been updated
10 changes: 5 additions & 5 deletions doc/dev/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The high-level view of the contributing workflow is:
2. Implement changes and tests on your own fork on a given branch
(``<gh-username>/autode:<branch-name>``).
3. Create a new pull request on the main autodE repository from your
development branch onto ``autode:master``.
development branch onto ``autode:v1.X``, where `X` is the latest version.

To learn more about GitHub forks and pull requests, read `Fork a
repo <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`__
Expand All @@ -62,13 +62,13 @@ on the GitHub docs.
Guidelines for pull requests
----------------------------

First, install from source in a new envrionment and setup
First, install from source in a new environment and setup
`pre-commit <https://pre-commit.com/>`__ with::

$ git clone https://github.com/duartegroup/autodE.git && cd autodE
$ conda create -n ade python=3.9 --file requirements.txt --channel conda-forge
$ conda activate ade
$ pip install . autode[dev]
$ pip install '.[dev]'
$ pre-commit install


Expand All @@ -86,8 +86,8 @@ Several, smaller pull requests instead of one big PR
Smaller pull requests (PRs) are reviewed faster, and more accurately. We
therefore encourage contributors to keep the set of changes within a
single pull request as small as possible. If your pull request modifies
more than 5 files, and/or several hundred lines of code, you should
probably break it down into two or more pull requests.
more than 5 files, and/or several hundred lines of code, please break it down
into two or more pull requests.


Pull requests are more than code
Expand Down

0 comments on commit e2b90c0

Please sign in to comment.