diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..3c934df59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,33 @@ +**Please read this first** + +Bugs in Cvxportfolio are defined as deviations between the behavior +of the code and its description in +[the documentation](https://www.cvxportfolio.com) or in the +[the accompanying paper](https://web.stanford.edu/~boyd/papers/pdf/cvx_portfolio.pdf). + +Features requests are well-received but will probably be answered with a +suggestion that you develop them and contribute. + +Issues for any other reason can as well be created. + +## Specifications +- Problem: Bug, feature request, or other? +- OS: +- Cvxportfolio version: +- Python version: +- Cvxpy version: +- Pandas version: +- Data: Downloaded by Cvxportfolio or user-provided? + + +## Description +A clear and concise description of the problem. + +## How to reproduce +Ideally a minimal snippet of code that reproduces the problem if possible. + +## Additional information +Extra context. + +## Output +Entire Cvxportfolio output including the entire stack trace (if applicable).