Update readme and contributors guide to follow the style in Ferrite.j…

…l. (#26)

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# FerriteDistributed.jl contributor guide
+
+Welcome to FerriteDistributed.jl contributor documentation! In this document you find
+information about:
+
+ - [Documentation](#documentation)
+ - [Reporting issues](#reporting-issues)
+ - [Code changes](#reporting-issues)
+
+If you are new to open source development in general there are many guides online to help
+you get started, for example [first-contributions][first-contributions]. Another great
+resource, which specifically discusses Julia contributions, is the video [Open source, Julia
+packages, git, and GitHub][tim-git].
+
+## Documentation
+
+Contributing to documentation is a great way to get started with any new project. As a new
+user you have a unique perspective of what things need to be documented and explained better
+-- if something confuses you, chances are you're not alone. Remember that also simple
+changes like fixing typos are welcome contributions. If you are looking for specific things
+to work on you can look at [open issues][open-issues].
+
+Small changes can be done easily in GitHub's web interface (see [Editing
+files][gh-edit-files]). Every page in the documentation have an `Edit on GitHub` button at
+the top, which takes you to the correct source file. The video [Making Julia documentation
+better][tim-doc] guides you through these steps.
+
+**Useful resources**
+ - General information about documenting Julia code in the [Julia manual][julia-doc].
+ - [Documentation for `Documenter.jl`][documenter] which is used to render the HTML pages.
+ - [Documentation for `Literate.jl`][literate] which is used for tutorials/examples.
+
+
+## Reporting issues
+
+If you have found a bug or a problem with FerriteDistributed.jl you can open an [issue][new-issue]. Try
+to include as much information about the problem as possible and preferably some code that
+can be copy-pasted to reproduce it (see [How to create a Minimal, Reproducible
+Example][so-mre]).
+
+If you can identify a fix for the bug you can submit a pull request without first opening an
+issue, see [Code changes](#code-changes).
+
+
+## Code changes
+
+Bug fixes and improvements to the code, or to the unit tests are always welcome. If you have
+ideas about new features or functionality it might be good to first open an
+[issue][new-issue] or [discussion][new-discussion] to get feedback before spending too much
+time implementing something.
+
+If you are looking for specific things to work on you can look at [open
+issues][open-issues].
+
+Remember to always include (when applicable): i) unit tests which exercises the new code,
+ii) documentation, iii) a note in the [CHANGELOG.md](CHANGELOG.md) file.
+
+
+[documenter]: https://juliadocs.github.io/Documenter.jl/
+[first-contributions]: https://github.com/firstcontributions/first-contributions
+[gh-edit-files]: https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository
+[julia-doc]: https://docs.julialang.org/en/v1/manual/documentation/
+[literate]: https://fredrikekre.github.io/Literate.jl/v2/
+[new-discussion]: https://github.com/Ferrite-FEM/FerriteDistributed.jl/discussions/new
+[new-issue]: https://github.com/Ferrite-FEM/FerriteDistributed.jl/issues/new
+[open-issues]: https://github.com/Ferrite-FEM/FerriteDistributed.jl/issues
+[so-mre]: https://stackoverflow.com/help/minimal-reproducible-example
+[tim-doc]: https://youtu.be/ZpH1ry8qqfw
+[tim-git]: https://youtu.be/cquJ9kPkwR8

README.md

@@ -1,6 +1,6 @@
 # FerriteDistributed.jl
 
-[![Build Status](https://github.com/termi-official/FerriteDistributed.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/termi-official/FerriteDistributed.jl/actions/workflows/CI.yml?query=branch%3Amain)
+![Build Status](https://github.com/termi-official/FerriteDistributed.jl/actions/workflows/CI.yml/badge.svg?branch=main)
 
 This package contains the distributed assembly infrastructure for [Ferrite.jl](https://github.com/Ferrite-FEM/Ferrite.jl).
 
@@ -9,3 +9,47 @@ This package contains the distributed assembly infrastructure for [Ferrite.jl](h
 
 > [!NOTE]
 > The current implementation is tested with [Ferrite#7e8a571](https://github.com/Ferrite-FEM/Ferrite.jl/commit/7e8a57150738094bb951d6e672fdeed205d0a1ff). This package is not compatible with the latest Ferrite release (0.3.14).
+
+## Documentation
+
+[![][docs-dev-img]][docs-dev-url]
+
+## Installation
+You can install FerriteDistributed from the Pkg REPL:
+```
+pkg> add Ferrite#7e8a571, FerriteDistributed
+```
+
+> [!NOTE]
+> You need a properly configured MPI.jl installation for FerriteDistributed to work. You can consult
+> the [latest MPI.jl configuration docs](mpi-config-docs) for details.
+
+## Contributing
+
+Contributions in all forms (bug reports, documentation, features, suggestions, ...) are very
+welcome. See [CONTRIBUTING](CONTRIBUTING.md) for more details.
+
+## Questions
+
+If you have questions about Ferrite.jl you're welcome to reach out to us on the [Julia
+Slack][julia-slack] under `#ferrite-fem` or on [Zulip][julia-zulip] under `#Ferrite.jl`.
+Alternatively you can start a [new discussion][gh-discussion] in the discussion forum on the
+repository. Feel free to ask us even if you are not sure the problem is with Ferrite.jl.
+
+If you encounter what you think is a bug please report it, see
+[CONTRIBUTING.md](CONTRIBUTING.md#reporting-issues) for more information.
+
+## Community Standards
+
+Please keep in mind that we are part of the Julia community and adhere to the
+[Julia Community Standards][standards].
+
+
+
+
+[docs-dev-url]: http://ferrite-fem.github.io/FerriteDistributed.jl/
+[mpi-config-docs]: https://juliaparallel.org/MPI.jl/latest/configuration/
+[standards]: https://julialang.org/community/standards/
+[julia-slack]: https://julialang.org/slack/
+[julia-zulip]: https://julialang.zulipchat.com/
+[gh-discussion]: https://github.com/Ferrite-FEM/FerriteDistributed.jl/discussions/new