Merge pull request #105 from lisc-tools/contrib

[MNT] - Update contributing & changelog

Author: TomDonoghue

CONTRIBUTING.md

@@ -7,7 +7,7 @@ We welcome any contributions to the project that extend or improve code and/or d
 This page includes information for how to get involved and contribute to the project, and guidelines for how to do so.
 
 This project adheres to a
-[code of conduct](https://github.com/lisc-tools/liscp/blob/main/CODE_OF_CONDUCT.md)
+[code of conduct](https://github.com/lisc-tools/lisc/blob/main/CODE_OF_CONDUCT.md)
 that you are expected to uphold when participating in this project.
 
 On this page, you can find information on:
@@ -20,7 +20,8 @@ On this page, you can find information on:
 
 ## Reporting a Problem
 
-To report an issue with the code, please submit it to our [issue tracker](https://github.com/lisc-tools/lisc/issues).
+To report an issue with the code, please submit it to our
+[issue tracker](https://github.com/lisc-tools/lisc/issues).
 
 In doing so, please try to include the following:
 
@@ -49,7 +50,8 @@ If you have a new idea you would like to suggest or contribute, please do the fo
 If you are interested in getting involved and helping with the project, a great place to start is to visit the
 [issues](https://github.com/lisc-tools/lisc/issues) or
 [development](https://github.com/lisc-tools/Development) page
-and see if there is anything you would be interested in helping with. If so, join the conversation, and project developers can help get you started.
+and see if there is anything you would be interested in helping with.
+If so, join the conversation, and project developers can help get you started.
 
 ## Project Scope
 
@@ -62,18 +64,17 @@ such as custom or custom web scraping and/or novel natural language processing (
 
 ## Making a Contribution
 
-If there is a feature you would like to add, or an issue you saw that you think you can help with, you are ready to make a submission to the project!
+If there is a feature you would like to add, or an issue you saw that you think you can help with, you are ready to make a submission to the project! If you are working on a feature, please indicate so in the relevant issue, so that we can keep track of who is working on what.
 
-If you are working on a feature, please indicate so in the relevant issue, so that we can keep track of who is working on what.
+All contributions are managed through Github.
+If you are ready to start working on a contribution, you should follow the Github
+[guidelines for contributing to a project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project), which include forking the repository, making your suggested changes to the code, and then opening a pull request (PR) to suggest the code to the project.
 
-Once you're ready to start working on your contribution, do the following:
+Once you open a PR, developers will review the code. Please make sure to check and follow the
+[project conventions](#project-conventions) so that all new or updated code follows the guidelines.
 
-1. [Fork this repository](https://help.github.com/articles/fork-a-repo/), which makes your own version of this project you can edit
-2. [Make your changes](https://guides.github.com/activities/forking/#making-changes), updating or adding code to add the desired functionality
-3. [Check the project conventions](#project-conventions), and make sure all new or updated code follows the guidelines
-4. [Submit a pull request](https://help.github.com/articles/proposing-changes-to-a-project-with-pull-requests/), to start the process of merging the new code to the main branch
-
-If it's your first time contributing to open source software, check out this free resource on [how to contribute to an open-source project on GitHub](https://app.egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
+If it's your first time contributing to open source software, check out this free resource on
+[how to contribute to open-source projects on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 
 ## Project Conventions
 
@@ -120,9 +121,7 @@ All code contributed to the module should follow these conventions:
     * Any new functionality should be added and described in the tutorials and/or examples
         * If a new approach is added, a new tutorial or example may be appropriate
     * To build and check the documentation locally:
-        * Install the requirements for the docsite (`pip install -r requirements-doc.txt`)
+        * Install the requirements for the docsite (`pip install -r requirements-docs.txt`)
         * Move to the `lisc/doc` directory (`cd doc`)
         * Run `make html` to create a local copy of the documentation website
         * The documentation can then be opened in a web browser by opening the file `lisc/doc/_build/html/index.html`
-
-For more guidelines on how to write well formated and organized code, check out the [Python API Checklist](http://python.apichecklist.com).

doc/changelog.rst

@@ -1,30 +1,14 @@
 Code Changelog
 ==============
 
-This page contains the changelog for the `lisc` module and any notes on updating between versions.
+This page contains the changelog for the `lisc` module.
 
-Notes on the specific updates related to each release are also available on the
+This page primarily notes changes for major version updates, as well as any notes on updating between versions. For notes on the specific updates included within minor releases, see the
 `release page <https://github.com/lisc-tools/lisc/releases>`_.
 
 Note that between release versions, the general code API should stay consistent, so code from previous releases should generally be compatible with this release. However, internal objects and functions may change, such that saving / loading objects and processing already collected data may be slightly different. It is generally recommended that data be collected and processed within the same version of the module. If you need to load / process data from a different release version, you may need to check if the processing works, and update some things to make it work.
 
-0.2.X
------
+0.X.X Series
+------------
 
-The 0.2.X series is the current release series of the module.
-
-This series is a non-breaking update on the prior release.
-
-The main updates in this update include:
-- Internal updates to the LISC objects, and processing (including PRs #36, #39, #50, #60,  #67, #68)
-- Internal updates to the collection procedures (including PRs  #49, #53, #61)
-- Updates to available plotting utilities and saving (including PRs #41, #54, #66)
-- Extended Pubmed collection to use additional settings, including setting date ranges (including PR #44)
-- Add OpenCitations option to collect DOIs of citing papers (including PR #27)
-- Miscellaneous bug fixes (including PRs #62, #69)
-- General documentation updates (including PRs #30, #31, #38, #43, #45, #46, #64)
-
-0.1.X
------
-
-The 0.1.X series was the initial release series of the module.
+The 0.X.X series, starting with 0.1.0 and currently ongoing is the initial major version and release series of the module.

requirements-docs.txt

@@ -3,10 +3,4 @@ sphinx
 sphinx_gallery
 sphinx_bootstrap_theme
 sphinx-copybutton
-numpydoc
-
-# Optional dependencies that are required for building documentation
-matplotlib
-seaborn
-scipy
-wordcloud
+numpydoc