Commit graph

24 commits

Author SHA1 Message Date
Jonathan Wren
f5e052937c
Update copyright year (#1502)
Update copyright year in comment headers and --version output
2022-06-18 11:30:56 -07:00
Micah Jerome Ellison
b1ba88c138
Migrate contributing.md to docs site (#1266)
* Initial migration of contributing.md to docs site
* Update contributing to include pytest-bdd changes
* add top level section support, and h2 support in sidebar
* Incorporate latest changes to contributing.md, clean up language and formatting, and check/add links as necessary
* Add a link to milestones
* Update CONTRIBUTING.md

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
2021-10-16 15:21:49 -07:00
Jonathan Wren
44edb9bdee
Add more steps to pytest, fully remove behave (#1347)
* update yaml loader to new method

* Add config overrides steps to pytest

This requires some patching around the config object, which now happens
in every test.

Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>

* udpate docs for new tests

* remove behave from deps

* remove feature dir from flake8 checks

* udpate lock file

* disable pip version check (it keeps spamming the pipeline)

Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>
2021-10-09 12:10:08 -07:00
Gustavo Matias
6980ed1906
Emphasize installing dependencies before testing (#1148)
As a beginner in Python it wasn't clear that `poetry install` needed to be run before `make test` for instance. That threw a sort of obscure error until I figured it out what the solution was. This is extremely minor, but make sure installing dependencies is the very first instruction can reduce some friction when contributing.
2021-01-09 11:07:03 -08:00
Micah Jerome Ellison
9fe56b9e10
Comply with GPL by acknowledging all authors and including license info in each source file (#1121)
* Update authors to "jrnl contributors" to comply with GPL3
* Include jrnl email address with contributors
* Include GPL notice in jrnl --version
* Apply consistent copyright and license to all Python files
* Add copyright and license to documentation
* Add copyright and license to docs theme
* Wiping poetry cache to try to resolve a test issue
* Testing with Python 3.9.0 in attempt to bypass GitHub Actions failure in 3.9.1
* make format
* Exclude Windows Python 3.9 build which is failing due to a GitHub Actions problem
* Modify testing to get around this 3.9 issue...
* Fix exclude
2020-12-19 22:28:22 -08:00
Felix Yan
c9f76e595e
Correct typos in CONTRIBUTING.md (#1040) 2020-09-05 10:53:10 -07:00
Micah Jerome Ellison
8d702fee9d Add unit testing via pytest (#987)
* Add pytest to project

Includes a couple sample tests, a note in CONTRIBUTING, and inclusion in the makefile

* Include pytest in Travis build
2020-06-20 14:30:15 -07:00
Jonathan Wren
919ab7902d Rename master branch to release (#985)
It's not our main branch anyway, and "release" makes it more clear what
it's for. There's an industry-wide trend to move away from terms that
invoke master/slave relationships in order to make members of
marginalized populations slightly less uncomfortable.
2020-06-20 14:11:03 -07:00
Micah Jerome Ellison
7a328d0fe3 Update and reorganize CONTRIBUTING (#885)
* Include information about branching strategy
* Re-organize documentation and include information on testing
* Use gerund form in Contributing headlines
* Fix markdown links and expand developing documentation
* Add pipx link and explain test code structure
* Include pull request process in CONTRIBUTING
* Update CONTRIBUTING with small changes from PR review
* Mention failing tests in CONTRIBUTING
* Add information for developers about issue labels
2020-04-10 11:51:56 -07:00
Micah Jerome Ellison
b95193d05a [GH-693] cleaning up "Developing" section and adding a note about behave 2020-04-10 11:51:55 -07:00
Micah Jerome Ellison
f8fc5f4786 [GH-693] work so far on updating developer documentation 2020-04-10 11:51:55 -07:00
MinchinWeb
e65a6eed58 fix typos, spelling (#734) 2020-04-10 11:51:55 -07:00
Manuel Ebert
ba59b1bded Fix references to Sphinx in contributing.md 2020-04-10 11:51:55 -07:00
Micah Jerome Ellison
1e0920eff0 [GH-598] Changing references from jrnl-plus back to jrnl and ensuring the URLs are valid (except build badge) 2020-04-10 11:51:55 -07:00
Jonathan Wren
20c6010621 update contributing file 2020-04-10 11:51:55 -07:00
Jenny Li
9ec6569628 minor typo fixes (#515) 2018-02-16 14:35:47 -08:00
Manuel Ebert
c159610723 Merge pull request #226 from grplyler/master
Fixed typo in CONTRIBUTING.md
2014-06-30 21:11:47 +02:00
Manuel Ebert
e0a603bcb8 Notes on encryption 2014-06-30 18:00:38 +02:00
grplyler
5dae85370f Fixed typo in CONTRIBUTING.md
Changed "sooner or later get implement it" to
"sooner or later get implemented."
2014-06-30 18:39:06 +08:00
Manuel Ebert
5b4e89f081 New make options 2014-06-30 11:14:25 +02:00
Manuel Ebert
ed3772df11 Clarifications on writing docs 2014-06-24 18:41:49 +02:00
Manuel Ebert
19ce72623c Update CONTRIBUTING.md 2014-05-22 14:19:24 -07:00
William Minchin
6cf0651e32 your chance to make a programmer happy :)
fix small typo in CONTRIBUTING.md
2013-11-27 09:11:01 -07:00
Manuel Ebert
30835524bc Contributing 2013-11-05 10:23:26 -08:00