diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..4dcb836 --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,26 @@ +# Configuration for welcome - https://github.com/behaviorbot/welcome + +# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome + +# Comment to be posted to on first time issues +newIssueWelcomeComment: > + ![Thank You Banner](https://raw.githubusercontent.com/physiopy/physiopy-test-workflows/master/welcome_banner.png) + + 🎉 Thank you for opening your first issue in this Physiopy repo! Please check our [contributor guide](https://physiopy.github.io/contributors-guide/) and follow the issue template. + +# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome + +# Comment to be posted to on PRs from first time contributors in your repository +newPRWelcomeComment: > + ![Thank You Banner](https://raw.githubusercontent.com/physiopy/physiopy-test-workflows/master/welcome_banner.png) + + 🎉 Thanks for opening your first pull request in this Physiopy repo! Please check our [contributor guide](https://physiopy.github.io/contributors-guide/) and follow the PR template. + +# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge + +# Comment to be posted to on pull requests merged by a first time user +firstPRMergeComment: > + ![Thank You Banner](https://raw.githubusercontent.com/physiopy/physiopy-test-workflows/master/welcome_banner.png) + + 🎉 Congrats on merging your first pull request in this repo! We appreciate your contribution to the Physiopy community! + :eyes: Please check that your contribution is correctly reported in the README of this repo and on [Physiopy's website](https://physiopy.github.io/community/team/)! \ No newline at end of file diff --git a/README.md b/README.md index d2faac0..84746f0 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,10 @@ This is a template for physiopy's repositories (and other repositories based on Remember to change the licence as soon as you adopt the template. +This repository is meant to be a template for python3 projects. If the repository you are making is more documentation focused, you may not require all the of the configurations below. + Available Configurations ------------------------ -This repository is meant to be a template for python3 projects. - CircleCI medium docker running Linux (python 3.7, 3.10, style checks, and coverage) - Auto release based on Github versioning with Physiopy's labels. - `.gitattributes` for python @@ -21,14 +22,15 @@ This repository is meant to be a template for python3 projects. - Versioneer - Issue templates (bugs, feature requests, generic) - PR template -- Workflows (Auto release and PyPI upload) +- Workflows (Auto release, PyPI upload, Auto label) +- Welcome bot (via `config.yml`) Usage ----- 1. Find and replace the items between `<>`, for instance `` 2. Change licence 3. Set up your default pushes to `origin` (`git config remote.pushDefault origin`) -4. Finish setting up everything. +4. Remove or add configurations; finalise set up. More explanation coming soon. @@ -54,7 +56,7 @@ More explanation coming soon. [![Supports python version](https://img.shields.io/pypi/pyversions/)](https://pypi.org/project//) -[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat)](#contributors) +[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat)](#contributors-) ```` is a python3 library meant to do something. @@ -66,10 +68,9 @@ More explanation coming soon. [Read the latest documentation](https://.readthedocs.io/en/latest/) for more information on ! ## Tested OSs -We woudl love to do that, but for teh moment we cannot support **Windows or MacOS testing**. The reason is related to the cost of running such tests: for each non-Linux test, we can run up to 8 tests on Linux instead. Partial Windows and MacOS testing might be introduced in future releases. +We would love to do that, but for the moment we cannot support **Windows or MacOS testing**. The reason is related to the cost of running such tests: for each non-Linux test, we can run up to 8 tests on Linux instead. Partial Windows and MacOS testing might be introduced in future releases. -Hence, while **we cannot ensure that will run on Windows or MacOS**, however we don't see any reason it shouldn't. -Besides, it will run on Windows Linux Subsistems. +Hence, while **we cannot ensure that will run on Windows or MacOS**, we don't see any reason it shouldn't. Besides, it will run on Windows Linux Subsystems. We apologise for the discomfort. @@ -87,12 +88,12 @@ Check the issues with a `BrainWeb` label. Of course, they are only suggestions, You can also contact us on Gitter, in the BrainHack Mattermost (#physiopy), and don't hesitate to contact [Stefano](https://github.com/smoia) in other ways to jump in the development! --> +## Contributors ✨ + **We're looking for code contributors,** but any suggestion/bug report is welcome! Feel free to open issues! This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! -## Contributors ✨ - Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):