Skip to content

Commit

Permalink
contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryansurf committed May 24, 2024
1 parent 30eb8d9 commit cb6180f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit cb6180f

Please sign in to comment.