diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ded0b9f..80ae069 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,7 +7,7 @@ body: attributes: value: > #### - This template has been inspired from [scikit-learn](https://github.com/scikit-learn/scikit-learn/tree/main/.github/ISSUE_TEMPLATE). + This template has been taken from [scikit-learn](https://github.com/scikit-learn/scikit-learn/tree/main/.github/ISSUE_TEMPLATE). Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the past issues](https://github.com/rmj3197/QuadratiK/issues). - type: textarea diff --git a/.github/ISSUE_TEMPLATE/documentation_improvement.yml b/.github/ISSUE_TEMPLATE/documentation_improvement.yml index 3e15f15..03828c9 100644 --- a/.github/ISSUE_TEMPLATE/documentation_improvement.yml +++ b/.github/ISSUE_TEMPLATE/documentation_improvement.yml @@ -7,7 +7,7 @@ body: attributes: value: > #### - This template has been inspired from [scikit-learn](https://github.com/scikit-learn/scikit-learn/tree/main/.github/ISSUE_TEMPLATE). + This template has been taken from [scikit-learn](https://github.com/scikit-learn/scikit-learn/tree/main/.github/ISSUE_TEMPLATE). - type: textarea attributes: label: Describe the issue linked to the documentation. diff --git a/.github/ISSUE_TEMPLATE/feature_inclusion.request.yml b/.github/ISSUE_TEMPLATE/feature_inclusion.request.yml index 258ffb6..0e88d92 100644 --- a/.github/ISSUE_TEMPLATE/feature_inclusion.request.yml +++ b/.github/ISSUE_TEMPLATE/feature_inclusion.request.yml @@ -6,7 +6,9 @@ body: - type: markdown attributes: value: > - #### If you want to propose a new algorithm or feature, please refer first email to raktimmu at buffalo.edu. + #### + This template has been taken from [scikit-learn](https://github.com/scikit-learn/scikit-learn/tree/main/.github/ISSUE_TEMPLATE). + If you want to propose a new algorithm or feature, please refer first email to raktimmu at buffalo.edu. - type: textarea attributes: label: Describe the feature you want to enable diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6c3a0f0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at `raktimmu at buffalo.edu `. +All complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, +available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) + +For answers to common questions about this code of conduct, see +[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq) \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2a66674 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,79 @@ +# Contributing to QuadratiK + +First of all, thanks for considering contributing to QuadratiK! + +[repo]: https://github.com/rmj3197/QuadratiK +[issues]: https://github.com/rmj3197/QuadratiK/issues +[new_issue]: https://github.com/rmj3197/QuadratiK/issues/new +[website]: https://quadratik.readthedocs.io/en/latest/ +[citation]: https://arxiv.org/abs/2402.02290 +[conduct]: https://quadratik.readthedocs.io/en/latest/development/CONTRIBUTING.html +[bug_report]: https://github.com/rmj3197/QuadratiK/issues/new?assignees=&labels=Bug%2CNeeds+Triage&projects=&template=bug_report.yml +[doc_improvement]: https://github.com/rmj3197/QuadratiK/issues/new?assignees=&labels=Documentation%2CNeeds+Triage&projects=&template=documentation_improvement.yml +[email]: mailto:raktimmu@buffalo.edu + +## Code of conduct + +Please note that this project is released with a [Contributor Code of Conduct][conduct]. By participating in this project you agree to abide by its terms. + +## How you can contribute + +There are several ways you can contribute to this project. + +### Share the love ❤️ + +Think QuadratiK is useful? Let others discover it, by telling them in person, via Twitter, ResearchGate or a blog post. + +Using QuadratiK for a paper you are writing? Consider [citing it][citation]. + +### Ask a question ⁉️ + +Using QuadratiK and got stuck? Browse the [documentation][website] to see if you can find a solution. Still stuck? Post your question as an [issue on GitHub][new_issue]. While we cannot offer user support, we'll try to do our best to address it, as questions often lead to better documentation or the discovery of bugs. + +Want to ask a question in private? Contact the package maintainer by [mail][email]. + +### Propose an idea 💡 + +Have an idea for a new QuadratiK feature? Take a look at the [documentation][website] and [issue list][issues] to see if it isn't included or suggested yet. If not, suggest your idea as an [issue on GitHub][new_issue]. While we can't promise to implement your idea, it helps to: + +- Explain in detail how it would work. +- Keep the scope as narrow as possible. + +See below if you want to contribute code for your idea as well. + +### Report a bug 🐛 + +Using QuadratiK and discovered a bug? That's annoying! Don't let others have the same experience and report it as an [issue on GitHub][new_issue] so we can fix it. A good bug report makes it easier for us to do so, please try to give as much detail as possible, at [Bug Report][bug_report]. + +### Improve the documentation 📖 + +Noticed a typo on the website? Think a function could use a better example? Good documentation makes all the difference, so your help to improve it is very welcome! Submit a issue here [Documentation Improvement][doc_improvement]. + +#### API documentation + +The API documentation is built automatically from the docstrings of classes, functions, etc. in the source files. The docs are built with sphinx and use the "sphinx_book_theme" theme. If you have the dependencies installed (tool.poetry.group.doc.dependencies inside pyproject.toml) you can build the documentation locally with `make html` in the /doc directory. Opening the /doc/build/index.html file with a browser will then allow you to browse the documentation and check your contributions locally. + +- Go to `QuadratiK/` directory in the [code repository][repo]. +- Look for the file with the name of the function. +- [Propose a file change](https://help.github.com/articles/editing-files-in-another-user-s-repository/) to update the function documentation in the roxygen comments (starting with `#'`). + +### Contribute code 📝 + +Care to fix bugs or implement new functionality for QuadratiK? Awesome! 👏 Have a look at the [issue list][issues] and leave a comment on the things you want to work on. See also the development guidelines below. + +## Development guidelines + +We try to follow the [GitHub flow](https://guides.github.com/introduction/flow/) for development. + +1. Fork [this repo][repo] and clone it to your computer. To learn more about this process, see [this guide](https://guides.github.com/activities/forking/). +2. If you have forked and cloned the project before and it has been a while since you worked on it, [pull changes from the original repo](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/) to your clone by using `git pull upstream master`. +3. Open the folder on your local machine using any code editor. +4. Make your changes: + + - Write your code. + - Test your code (bonus points for adding unit tests). + - Document your code (see function documentation above). + - Check your code with `pytest`. + +5. Commit and push your changes. +6. Submit a [pull request](https://guides.github.com/activities/forking/#making-a-pull-request). diff --git a/doc/build/.DS_Store b/doc/build/.DS_Store index 12ab3f9..d4bdeb9 100644 Binary files a/doc/build/.DS_Store and b/doc/build/.DS_Store differ