From 91ef84355e376cdeb9d80ba47f2468cf86740de9 Mon Sep 17 00:00:00 2001 From: kbonney Date: Thu, 16 Mar 2023 11:20:12 -0400 Subject: [PATCH 1/2] Updating contributing page and adding a few lines to gitignore --- .gitignore | 4 +- docs/pages/contributing.rst | 78 +++++++++++++++++++++++++++++++++---- 2 files changed, 73 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 57dc97f..fb24101 100644 --- a/.gitignore +++ b/.gitignore @@ -12,4 +12,6 @@ pvops/.vscode/* pvops/text2time/.vscode .vscode/* .vscode/settings.json -.coverage \ No newline at end of file +.coverage +.eggs +*.egg-info \ No newline at end of file diff --git a/docs/pages/contributing.rst b/docs/pages/contributing.rst index df76837..c371cff 100644 --- a/docs/pages/contributing.rst +++ b/docs/pages/contributing.rst @@ -10,16 +10,78 @@ and test before submitting code. Checking that your PR passes the required testing and linting procedures will speed up the acceptance of your PR. -**If you find errors in the codebase:** +Issues and bug reporting +------------------------ -1. Submit an issue at the `pvops issues page `_ +To report issues or bugs please create a new issue on +the `pvops issues page `_. -**If you would like to contribute:** +Following these guidelines will help maintainers understand your issue, +reproduce the behavior, and develop a fix in an expedient fashion. +Before submitting your bug report, please perform a cursory search +to see if the problem has been already reported. If it has been reported, +and the issue is still open, add a comment to the existing issue instead of opening a new issue. -2. Create a pull request (PR) or help with other PRs which are in the library - by referencing `pvops PR page `_. - Pull requests should contain code that follows the PEP8 python code style. +Guidelines for effective bug reporting +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**If you are confused:** +- Use a clear descriptive title for the issue. -3. Feel free to reach out to the package maintainer, found in ``setup.py``. +- Describe the steps to reproduce the problem, + the behavior you observed after following the steps, and the expected behavior. + +- If possible, provide a simple example of the bug using pvOps example data. + +- When relevant, provide information on your computing environment + (operating system, python version, pvOps version or commit). + +- For runtime errors, provide a function call stack. + +Contributing code +----------------- + +Software developers, within the core development team and external collaborators, +are expected to follow standard practices to document and test new code. +Software developers interested in contributing to the project are encouraged +to create a Fork of the project and submit a Pull Request (PR) using GitHub. +Pull requests will be reviewed by the core development team. +Create a PR or help with other PRs which are in the library +by referencing `pvops PR page `_. + +Guidelines for preparing and submitting pull-requests +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Use a clear descriptive title for your pull-requests + +- Describe if your submission is a bugfix, documentation update, or a feature + enhancement. Provide a concise description of your proposed changes. + +- Provide references to open issues, if applicable, to provide the necessary + context to understand your pull request + +- Make sure that your pull-request merges cleanly with the `master` branch of + pvOps. When working on a feature, always create your feature branch off of + the latest `master` commit + +- Ensure that appropriate documentation and tests accompany any added features. + + +Once a pull-request is submitted you will iterate with NuMAD maintainers +until your changes are in an acceptable state and can be merged in. You can push +addditional commits to the branch used to create the pull-request to reflect the +feedback from maintainers and users of the code. + +Questions and feature requests +-------------------------------- + +For any questions regarding pvOps or requests for additional features, +users may open an issue on the `pvops issues page `_ +or contact the package maintainer found in ``setup.py``. + +Guidelines for effective bug reporting +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Use a clear, descriptive title for the question or feature request. + +- If submitting a feature request, please provide context, examples, and + references when relevant. \ No newline at end of file From 710e67b9dc86b60e3bf19f2162e753dffc7141c9 Mon Sep 17 00:00:00 2001 From: kbonney Date: Thu, 16 Mar 2023 11:22:31 -0400 Subject: [PATCH 2/2] Small edit --- docs/pages/contributing.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/pages/contributing.rst b/docs/pages/contributing.rst index c371cff..44b6d73 100644 --- a/docs/pages/contributing.rst +++ b/docs/pages/contributing.rst @@ -15,9 +15,6 @@ Issues and bug reporting To report issues or bugs please create a new issue on the `pvops issues page `_. - -Following these guidelines will help maintainers understand your issue, -reproduce the behavior, and develop a fix in an expedient fashion. Before submitting your bug report, please perform a cursory search to see if the problem has been already reported. If it has been reported, and the issue is still open, add a comment to the existing issue instead of opening a new issue.