diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3a5e0a7..ac00712 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,28 +1,31 @@ --- name: Bug report -about: Create a report to help us improve +about: Found a bug? Let us know! title: "[Bug Placeholder Name]" labels: bug -assignees: '' - +assignees: "" --- ## Description -Any general details about the bug should go here. +_Any general details about the bug should go here._ ### To Reproduce -Steps to reproduce the behavior, if available. + +_Steps to reproduce the behavior, if available._ ### Expected behaviour -(Optional) What do you expect to happen instead? + +_(Optional) What do you expect to happen instead?_ ### Screenshots -(Optional) If applicable, add screenshots! This is particularly useful for graphical glitches. -### Environment: -Report any useful system details here +_(Optional) If applicable, add screenshots! This is particularly useful for graphical glitches._ - - OS [e.g. NixOS, Debian, Ubuntu, Windows] - - GHCiTUI Version [e.g. 0.1.0.0] - - If building from source, `cabal freeze` output. +### Environment + +_Report any useful system details here._ + +- OS: _[e.g. NixOS, Debian, Ubuntu, Windows]_ +- GHCiTUI Version: _[e.g. 0.1.0.0]_ +- _If building from source,_ `cabal freeze` _output._ diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ceeac3..26b0480 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,31 @@ # Revision history for ghcitui -## 0.1.0.0 -- YYYY-mm-dd +## 0.1.0.0 -- 2024-01-21 -* First version. Released on an unsuspecting world. +First release! This is a "public beta" release, which we try to get feedback for higher priority +features. + +### Features + +- The public Ghcitui library. +- Ghcid connection set up. +- Source code viewer. +- GHCi REPL +- Current Bindings. +- Available Modules. +- Tracing. +- Debug console. + +### Bug fixes + +- None--this is the first release. + +### Known issues + +(See https://github.com/CrystalSplitter/ghcitui/issues for the latest issues.) + +- Occasionally we get a SEGV on start up. Uncertain why. Very infrequent--likely a race condition + in Vty or GHCiD? +- String variables which contain quotes are not parsed correctly. +- Unable to interrupt expressions (hopefully fixed in a future version?) +- Currently no remapping of keybindings or colours. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b4afc5..6696393 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,33 @@ # Contributing +## Contributing as a User + We're open to contributions! You can help by filing issues and making pull requsets. Comments, contributions, and any other forms of communication within this project must abide by the [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct). -## Style +### I Found A Bug! Where Do I Report It? + +That's great! Please check our [known issues] so far before filing one. If your bug isn't +already there, please file it [here](new-bug)! + +### I Want a Feature! Where Do I Request It? + +Please file a feature request [here][new-issue]! We may +not be able to add the feature due to low resources, but it's good to have a record of what users +want. + +## Contributing as a Developer + +Always happy to have more collaborators on this project! Check out the [issues][known issues] +to look for any open bugs or feature requests. If you intend to work on one, please add a comment +to it saying you are. + +Also please check out the coding style, and make sure that you abide by the Contributor Convenant +Code of Conduct. + +## Coding Style This project is auto-formatted currently by Fourmolu, with settings specified in [fourmolu.yaml](./fourmolu.yaml). This is subject to change. @@ -47,23 +69,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or advances of +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email address, +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -155,6 +177,9 @@ For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. +[known issues]: https://github.com/CrystalSplitter/ghcitui/issues +[new-bug]: https://github.com/CrystalSplitter/ghcitui/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBug+Placeholder+Name%5D +[new-issue]: https://github.com/CrystalSplitter/ghcitui/issues/new [homepage]: https://www.contributor-covenant.org [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html [Mozilla CoC]: https://github.com/mozilla/diversity diff --git a/README.md b/README.md index 9a48faf..6bc00c4 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,8 @@ code viewport panel, you may press `` to get to the viewport panel. ## Contributing -Contributors are welcome! Please see [CONTRIBUTING]. -to see how. +Contributors are welcome! Please see [CONTRIBUTING] to see how. [INSTALLATION]: https://github.com/CrystalSplitter/ghcitui/blob/main/INSTALL.rst [manual]: https://github.com/CrystalSplitter/ghcitui/blob/main/MANUAL.rst -[CONTRIBUTING]: https://github.com/CrystalSplitter/ghcitui/blob/main/CONTRIBUTING.md \ No newline at end of file +[CONTRIBUTING]: https://github.com/CrystalSplitter/ghcitui/blob/main/CONTRIBUTING.md