Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Circle CI Build + CONTRIBUTING.md #265

Merged
merged 2 commits into from
Oct 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 7 additions & 18 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,6 @@ flake8-steps: &steps


jobs:
Python34:
docker:
- image: circleci/python:3.4
steps: *steps

Python35:
docker:
- image: circleci/python:3.5
steps: *steps

Python36:
docker:
- image: circleci/python:3.6
steps: *steps

Python37:
docker:
- image: circleci/python:3.7
Expand All @@ -46,13 +31,17 @@ jobs:
- image: circleci/python:3.9
steps: *steps

Python310:
docker:
- image: circleci/python:3.10
steps: *steps

workflows:
version: 2
build:
jobs:
- Python34
- Python35
- Python36
- Python37
- Python38
- Python39
- Python39
- Python310
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributing to the NBA-API

Welcome, and thank you for your interest in contributing to the NBA-API!

There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.

## Asking Questions

Have a question? Rather than opening an issue, head over to the [NBA-API Slack Workspace](https://join.slack.com/t/nbaapi/shared_invite/enQtOTY0MjIwMTI2ODIwLWIzZGFmMjQ4MDk4MTVmMTA2NWEwYmQzZDRiYTM3NDI4OWY5NGJiY2Q1M2EwZGUzOTQ1MTk4MDEyZGI1NGM2ZDI) to connect with others, chat, and receive help.

## Reporting Issues

Have you identified a reproducible problem? Have a feature request? Identified a missing endpoint? Here's how you can make reporting your issue as effective as possible.

### Look For an Existing Issue

Before you create a new issue, please do a search in [open issues](https://github.com/microsoft/nba_api/issues) to see if the issue or feature request has already been filed.

If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment:

* 👍 - upvote
* 👎 - downvote

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

### Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.

Please include the following with each issue:

* Version of the nba-api you are using

* Reproducible steps (1... 2... 3...) that cause the issue

* What you expected to occur, versus what you actually occur

* A code snippet that demonstrates the issue or a link to a code repository that can easily be pull down to recreate the issue locally

* **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.

### Final Checklist

Please remember to do the following:

* [ ] Search the issue repository to ensure your report is a new issue

* [ ] Recreate the issue

* [ ] Simplify your code around the issue to better isolate the problem