From 037e598b36ac3b28408a8478ed04b76f1d4dbbe3 Mon Sep 17 00:00:00 2001 From: Bram van den Heuvel Date: Fri, 15 Dec 2023 15:05:48 +0100 Subject: [PATCH 1/5] elm-format --- src/Matrix.elm | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/Matrix.elm b/src/Matrix.elm index 54dce72..5042f58 100644 --- a/src/Matrix.elm +++ b/src/Matrix.elm @@ -1,5 +1,9 @@ module Matrix exposing (Vault) -{-| # Matrix SDK + +{-| + + +# Matrix SDK This first version forms a mere basis from which we will create iterative builds that slowly improve the codebase. @@ -8,13 +12,18 @@ It is generally quite unusual to regularly publish iterative beta versions on the public registry, but it is also generally quite unusual to exclusively support a monolithic public registry. (: + ## Vault @docs Vault + -} + {-| The Vault type stores all relevant information about the Matrix API. It currently supports no functionality and it will just stay here - for fun. + -} -type Vault = Vault +type Vault + = Vault From 31d176d110caebaa66bc5368c38d677d64f6ca6e Mon Sep 17 00:00:00 2001 From: Bram van den Heuvel Date: Fri, 15 Dec 2023 18:29:25 +0100 Subject: [PATCH 2/5] Add CONTRIBUTING.md --- README.md | 5 ++++ docs/CONTRIBUTING.md | 71 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index b40a3c9..8d6417e 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,8 @@ elm install noordstar/elm-matrix-sdk-beta Keep in mind that the beta versions are intended to develop rapidly. You should not expect the versions to remain reliable for years! If you need a stable version, please wait around for a full version. + +## Contribute + +If you wish to contribute, please read the +[contribution guide](docs/CONTRIBUTE.md). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..221e7ed --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contributing to elm-matrix-sdk-beta + +Welcome to the elm-matrix-sdk-beta repository! We appreciate your interest in +contributing. Please take a moment to review the following guidelines. + +## Table of Contents + +1. [How to Contribute](#how-to-contribute) +2. [Bug Reports](#bug-reports) +3. [Code Contributions](#code-contributions) +4. [Documentation Improvements](#documentation-improvements) +5. [Feedback and Tips](#feedback-and-tips) +6. [Development Environment](#development-environment) +7. [Pull Requests](#pull-requests) +8. [Communication](#communication) +9. [License](#license) + +--- + +## How to Contribute + +We welcome various forms of contributions, including bug reports, code +contributions through pull requests from forks, suggestions for documentation +improvement, and helpful tips and feedback based on user experience. + +## Bug Reports + +When reporting bugs, please provide as much detail as possible, including steps +to reproduce, expected behavior, actual behavior, and details about your +environment. + +## Code Contributions + +1. Fork the repository. +2. Create a new branch from the `develop` branch. +3. Write your code and commit changes. +4. Push your branch to your fork. +5. Submit a pull request to the `develop` branch. + +## Documentation Improvements + +Feel free to suggest improvements to the documentation. Ensure that your +suggestions are clear and concise. + +## Feedback and Tips + +We appreciate feedback, tips, and suggestions based on user experience. Share +your thoughts to help us enhance the project. + +## Development Environment + +To set up your development environment: + +1. Install Elm. +2. Use `elm-format` to format your Elm code. +3. Run `elm make --docs=docs.json` to generate documentation. +4. View documentation using an Elm documentation viewer (e.g., [elm-doc-preview](https://elm-doc-preview.netlify.app/)). +5. Expose modules in `elm.json` for documentation. + +## Pull Requests + +Create a fork, write your code, and submit a pull request to the `develop` branch. + +## Communication + +- Mastodon: [@elm_matrix_sdk@social.noordstar.me](https://social.noordstar.me/@elm_matrix_sdk) +- Matrix: [#elm-sdk:matrix.org](https://matrix.to/#/#elm-sdk:matrix.org) + +## License + +This project is licensed under the [EUPL-v1.2](LICENSE). Please review the license file for more details. From 70d44c2cb6101ccf3743879e8242f107db185db9 Mon Sep 17 00:00:00 2001 From: Bram Date: Sat, 16 Dec 2023 01:49:13 +0100 Subject: [PATCH 3/5] Add guidelines to merging branches --- docs/before-merge.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/before-merge.md diff --git a/docs/before-merge.md b/docs/before-merge.md new file mode 100644 index 0000000..aeeade8 --- /dev/null +++ b/docs/before-merge.md @@ -0,0 +1,29 @@ +# Before merging to main + +⚠️ **Hold up!** Before you merge that pull request, make sure to follow this checklist! + +## Any branch to `develop` + +If you wish to merge your branch to the `develop` branch, make sure to follow this checklist: + +- [ ] Run `elm-format` to ensure the correct formatting of the Elm files. +- [ ] Use `elm-doc-preview` to verify whether the documentation is up to standards. + +## The `develop` branch to `main` + +The `develop` branch is the only branch that's allowed to merge to `main`. Once the branch merges to `main`, that indicates a new release on the Elm registry. + +Before that is being done, however, the following tasks should be done: + +- [ ] Run `elm-format` to ensure the correct formatting of the Elm files. +- [ ] Use `elm-doc-preview` to verify whether the documentation is up to standards. +- [ ] Remove exposed modules from `elm.json` that do not need to be exposed modules in the release. +- [ ] Run `elm bump` to update the library's version number +- [ ] Update the version name in the [default values config file](../src/Internal/Config/Default.elm). + +## Any branch to any other branch + +There are no limitations to merging other branches towards one another, although it is important to keep in mind that: + +- Contributors are advised to merge the `develop` branch into their branches regularly to avoid any merge conflicts. +- Merging with branches that haven't been accepted (yet) might result in your branch ending up with code that will not be accepted. From ee1012f7834b24cf0eca89770502377fba8e7924 Mon Sep 17 00:00:00 2001 From: Bram Date: Mon, 18 Dec 2023 01:34:00 +0100 Subject: [PATCH 4/5] Add VSCode workspace settings to .gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 8b631e7..9cf9e69 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ elm-stuff # elm-repl generated files repl-temp-* +# VScode settings +.vscode/ From 2fd2eb4e5a3a313c5ac64cf71ff338b19d401906 Mon Sep 17 00:00:00 2001 From: Bram Date: Mon, 18 Dec 2023 01:57:14 +0100 Subject: [PATCH 5/5] Fix broken link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d6417e..5913ad2 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,4 @@ version, please wait around for a full version. ## Contribute If you wish to contribute, please read the -[contribution guide](docs/CONTRIBUTE.md). +[contribution guide](docs/CONTRIBUTING.md).