Skip to content

Commit 097e3af

Browse files
authored
update contributing docs (#28)
* update contributing docs - mention discussions - highlight element chat * typos and wording
1 parent 83f8620 commit 097e3af

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,15 @@ fis(service=1, food=2)
7373

7474
## Contributing
7575

76-
Contributions are welcome! If you find a bug or want to request a feature, [open an issue](https://github.com/lucaferranti/FuzzyLogic.jl/issues). You are also encouraged to send pull requests (PRs). For small changes, it is ok to open a PR directly. For bigger changes, it is advisable to discuss it in an issue first. Before opening a PR, make sure to check the [contributing guidelines](https://lucaferranti.github.io/FuzzyLogic.jl/dev/contributing).
76+
Contributions are welcome! Here is a small decision tree with useful links.
77+
78+
- To chat withe the core dev(s), you can use the [element chat][chat-url]. This is a good entry point for less structured queries.
79+
80+
- If you find a bug or want to request a feature, [open an issue](https://github.com/lucaferranti/FuzzyLogic.jl/issues).
81+
82+
- There is a [discussion section](https://github.com/lucaferranti/FuzzyLogic.jl/discussions) on GitHub. You can use the [helpdesk](https://github.com/lucaferranti/FuzzyLogic.jl/discussions/categories/helpdesk) for asking for help on how to use the software or the [show and tell](https://github.com/lucaferranti/FuzzyLogic.jl/discussions/categories/show-and-tell) to share with the world your work using FuzzyLogic.jl.
83+
84+
- You are also encouraged to send pull requests (PRs). For small changes, it is ok to open a PR directly. For bigger changes, it is advisable to discuss it in an issue first. Before opening a PR, make sure to check the [contributing guidelines](https://lucaferranti.github.io/FuzzyLogic.jl/dev/contributing).
7785

7886
## Copyright
7987

docs/src/contributing.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
First of all, huge thanks for your interest in the package! ✨
44

5-
This page has some tips and guidelines on how to contribute.
5+
This page has some tips and guidelines on how to contribute. For more unstructured discussions, you can chat with the developers in the [element chat](https://app.gitter.im/#/room/#FuzzyLogic-jl:gitter.im).
6+
7+
## Discussions
8+
9+
If you are using FuzzyLogic.jl in your work and get stuck, you can use the [helpdesk](https://github.com/lucaferranti/FuzzyLogic.jl/discussions/categories/helpdesk) to ask for help. This is preferable over issues, which are meant for bugs and feature requests, because discussions do not get closed once fixed and remain browsable for others.
10+
11+
There is also a [show and tell](https://github.com/lucaferranti/FuzzyLogic.jl/discussions/categories/show-and-tell) section to share with the world your work using FuzzyLogic.jl. If your work involves a new application of FuzzyLogic.jl and you also want it featured in the Applications section in the documentation, let us know (in the element chat or in an issue). You will get help with the workflow and setup, but you are expected to do the writing 😃 .
612

713
## Opening issues
814

0 commit comments

Comments
 (0)