Merge pull request #14 from kconnour/cleanup

Cleanup project files

.github/pull_request_template.md

@@ -1,18 +1,18 @@
 ### Quick Summary
 <!-- Choose one-->
+- [ ] Feature addition
 - [ ] Bug fix
 - [ ] Documentation fix
-- [ ] Feature addition
 - [ ] Refactoring current code
 - [ ] Other
 
 ### Related issues
-<!-- Post the issue #, discussion, etc. if applicable. -->
+<!-- If applicable, post the issue #, discussion, etc. -->
 
 ### Extended summary
 <!-- Describe what will be changed if this request is approved. -->
 
 ### Pull Request Checklist
  - [ ] Code Follows PEP8 guidelines (explain any exceptions)
  - [ ] Code is appropriately type hinted
- - [ ] Code has associated unit tests where appropriate
+ - [ ] Code has associated unit tests where appropriate

.github/workflows/main.yml

@@ -1,15 +1,15 @@
-# Upon a push to master, this workflow will:
+# Upon a push to main, this workflow will:
 # -- install mars_time
 # -- run all tests
-# -- run the linter
+# -- run a linter
 
 name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
   workflow_dispatch:
 
@@ -21,7 +21,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-20.04, ubuntu-22.04, macos-11, macos-12]
-        python-version: [3.9, "3.10", "3.11"]
+        python-version: ["3.10", "3.11"]
 
     runs-on: ${{ matrix.os }}
 
@@ -44,4 +44,4 @@ jobs:
 
       - name: Lint with pylint
         run: |
-          python -m pylint --exit-zero mars_time
+          python -m pylint --exit-zero mars_time

.gitignore

@@ -2,6 +2,5 @@ __pycache__
 venv
 .idea
 .pytest_cache
-.DS_store
 .tox
-*mer.egg-info
+*.egg-info

CONTRIBUTING.md

@@ -1,12 +1,12 @@
-### Contributing
+Contributing
+============
 
-To contribute to this project you can do either of the following:
+To contribute to this project, you can do any of the following:
 
-1. Tell me what to change (recommended; easy for you but hard for me)
-   Let me know what you want fixed by using either the Issues or Discussions
-   tabs. When I can, I'll try to add/fix code based on your comments.
-
-2. Do it yourself (harder for you but easy for me)
-   Create a fork of this repo. Develop a particular feature on your own branch
-   and submit a pull request. I'll take a look at it once you try to merge it.
-   If you use this option, please be sure to use the pull request template.
+* Raise an issue. This is primarily useful if you've found a bug. When I can,
+  I'll try to add/fix code based on your comments.
+* Start a discussion. This is primarily useful if you're requesting a new
+  feature. We can discuss if the feature should be added and how to do it.
+* Submit a pull request. This is primarily useful if you want to help me
+  develop mars_time. When I can, I'll take a look at your request. If you choose
+  this option, please be sure to use the pull request template.

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright 2021, mer developers
+Copyright 2023, mars_time developers
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

README.rst

@@ -1,19 +1,15 @@
-.. image:: https://github.com/kconnour/mars_time/workflows/CI/badge.svg?branch=master
+.. image:: https://github.com/kconnour/mars_time/workflows/CI/badge.svg?branch=main
      :target: https://github.com/kconnour/mars_time/actions?workflow=CI
      :alt: CI Status
 
-mars_time is a package for converting between Martian times and Earth times. It aims to be a "datetime" equivalent for
-Mars and provides conversions between:
+mars_time is a package for converting between Earth and Mars times. It aims to be a "datetime" equivalent for Mars and
+provides conversions between:
 
 * Mars years
 * datetimes
 * sols
 * solar longitude
 
-Links:
+If you're interested, check out the `documentation <https://kconnour.github.io/mars_time/>`_
 
-* `Source code <https://github.com/kconnour/mars_time/>`_
-* `Documentation <https://kconnour.github.io/mars_time/>`_
-* `Improvements <https://github.com/kconnour/mars_time/issues/>`_
-
-Feedback is welcome. Feel free to raise an issue if you find a bug or simply want to request a feature.
+Feedback is welcome. Feel free to raise an issue if you find a bug or simply want to request a feature.