From cb6180fdb2ab34c33bf3cea5e0f83304e130e574 Mon Sep 17 00:00:00 2001 From: ryansurf Date: Thu, 23 May 2024 17:36:11 -0700 Subject: [PATCH] contributing docs --- CONTRIBUTING.md | 14 ++++++++++++++ README.md | 17 +---------------- 2 files changed, 15 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d0c040..bcda52d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,20 @@ To find issues you can help with, go though the list of [good first issues](http Once you find an interesting issue let us know that you want to work on it by commenting on the issue. +## Development + +**Code Style and Quality** + +The [PEP 8](https://realpython.com/python-pep8/) styling convention is used. + +To make sure you are following it, you can install [pylint](https://pypi.org/project/pylint/) + +`pip install pylint` + +To run pylint: + +`pylint ./src` + ## Questions, suggestions or new ideas Please don't open an issue to ask a question or suggestion. Instead, use the [GitHub Discussions](https://github.com/ryansurf/cli-surf/discussions) page. New ideas and enhacements are also welcome as discussion posts. diff --git a/README.md b/README.md index 43bdda8..e11f647 100644 --- a/README.md +++ b/README.md @@ -112,27 +112,12 @@ You will need to setup an email account that is able to utilize SMTP services. I Execute by running `python3 send_email.py`. Running with cron is a good use case -## Development +## Contributing Thank you for considering contributing to cli-surf! See [CONTRIBUTING.md](https://github.com/ryansurf/cli-surf/blob/main/CONTRIBUTING.md) to get an idea of how contributions work. -**Code Style and Quality** - -The [PEP 8](https://realpython.com/python-pep8/) styling convention is used. - -To make sure you are following it, you can install [pylint](https://pypi.org/project/pylint/) - -`pip install pylint` - -To run pylint: - -`pylint ./src` - - -## Contributing - Questions? Comments? * [Discussions](https://github.com/ryansurf/cli-surf/discussions)