Skip to content

Commit

Permalink
links to github discussions (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
alustig3 committed Dec 24, 2022
1 parent 5b004f9 commit d67f26a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
20 changes: 11 additions & 9 deletions docs/contributing.md
@@ -1,16 +1,18 @@
# Contributing to pyControl

The pyControl project welcomes contributions from users and developers in the open source community. Contributions can be made in a number of ways, including:
The pyControl project welcomes contributions from users and developers in the open source community.
Contributions can be made in a number of ways, including:

- Sharing the project
- Asking questions or making suggestions in the [Discussions](link)
- Documentation improvements
- Bug reports and patch reviews
- Code patches via pull requests
- sharing the project
- asking/answering questions or sharing ideas/suggestions on the pyControl [discussions](https://github.com/orgs/pyControl/discussions) board
- improving documentation
- reporting bugs and reviewing code patches
- submitting code patches via pull requests

## Reporting an Issue

Please include as much detail as you can. Let us know your platform and pyControl version, and ideally include a screenshot of the error message.
Please include as much detail as you can.
Let us know your platform and pyControl version, and ideally include a screenshot of the error message.

- [code issues](https://github.com/pyControl/code/issues)
- [hardware issues](https://github.com/pyControl/hardware/issues)
Expand All @@ -26,8 +28,8 @@ If you have found pyControl useful, consider starring the [code repository on Gi

To get started developing for pyControl, fork the relevant pyControl repository on [GitHub](https://github.https://github.com/pyControl/code/pyControl).

The default branch of the repository contains the last numbered release.
The dev branch contains the latest version which typically has more features but may be more buggy.
The [master](https://github.com/pyControl/code/tree/master) branch of the repository contains the last numbered release.
The [dev](https://github.com/pyControl/code/tree/dev) branch contains the latest version which typically has more features but may be more buggy.
pyControl development should build on the latest commit in the dev branch to facilitate integrating it back into the codebase.

Once you are happy with your changes, or you are ready for some feedback, push it to your fork and send a pull request.
2 changes: 1 addition & 1 deletion docs/user-guide/troubleshooting.md
@@ -1,6 +1,6 @@
# Troubleshooting

The page details how to fix common problems that can occur when using pyControl. If you encounter a problem that is not covered on this page, please contact the [google group](https://groups.google.com/forum/#!forum/pycontrol).
The page details how to fix common problems that can occur when using pyControl. If you encounter a problem that is not covered on this page, please post in the [discussions](https://github.com/orgs/pyControl/discussions).

## The docs are wrong

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Expand Up @@ -30,8 +30,8 @@ nav:
- License: about/license.md

- Quick Links:
- Google group: https://groups.google.com/forum/#!forum/pycontrol
- GitHub repositories: https://github.com/pycontrol
- Help and Discussions: https://github.com/orgs/pyControl/discussions
- Repositories: https://github.com/pycontrol
- Manuscript: https://elifesciences.org/articles/67846

copyright: Copyright © 2016 - 2022 Thomas Akam
Expand Down

0 comments on commit d67f26a

Please sign in to comment.