Adding Contribution guide (#123)

* Add statement for non working examples to template
* Adding contribution guide
* Add statement about wayback machine
pull/127/head
simonsan 3 years ago committed by GitHub
parent 7fc0ae1cba
commit d89b51f4d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,49 @@
# Contributing
## Discssion board
If you have a question or an idea regarding certain content but you want to have feedback of fellow community members
and you think it may not be appropriate to file an issue open a discussion in our [discussion board](https://github.com/rust-unofficial/patterns/discussions).
## Writing a new article
Before writing a new article please check our [issues](https://github.com/rust-unofficial/patterns/issues) and
the [Pull Requests](https://github.com/rust-unofficial/patterns/pulls) if there are existing issues or someone
is working on that topic.
If you don't find an issue regarding your topic and you are sure it is not more feasible to open a thread in the [discussion board](https://github.com/rust-unofficial/patterns/discussions)
please open a new issue, so we can discuss about the ideas and future content of the article together and maybe
give some feedback/input on it.
When writing a new article it's recommended to copy the [pattern template](https://github.com/rust-unofficial/patterns/blob/master/template.md) into the
appropriate directory and start editing it. You may not want to fill out every section and remove it or you might want to add extra sections.
Consider writing your article in a way that has a low barrier of entry so also [Rustlings](https://github.com/rust-lang/rustlings) can follow
and understand the thought process behind it. So we can encourage people to use these patterns early on.
We encourage you to write idiomatic Rust code that builds in the [playground](https://play.rust-lang.org/).
If you use links to blogposts or in general content that is not to be sure existing in a few years (e.g. pdfs) please take a snapshot
with the [Wayback Machine](https://web.archive.org/) and use the link to that snapshot in your article.
Don't forget to add your new article to the `SUMMARY.md` to let it be rendered to the book.
Please make `Draft Pull requests` early so we can follow your progress and can give early feedback (see the following section).
## Creating a Pull Request
"Release early and often!" also applies to pull requests!
Once your article has some visible work, create a `[WIP]` draft pull request and give it a description of what you did or want to do.
Early reviews of the community are not meant as an offense but to give feedback.
A good principle: "Work together, share ideas, teach others."
### Important Note
Please **don't force push** your branch to keep commit history and make it easier of us to see changes between reviews.
Make sure to `Allow edits of maintainers` (under the text box) in the PR so people can actually collaborate on things or fix smaller issues themselves.

@ -8,6 +8,7 @@ language that you can read [here](https://rust-unofficial.github.io/patterns/).
[Introduction](intro.md)
### Idioms
* [Constructor](idioms/ctor.md)
@ -68,16 +69,11 @@ language that you can read [here](https://rust-unofficial.github.io/patterns/).
## Contributing
Contributions are very welcome!
You should start with [the template](template.md). Copy it into the appropriate
directory, edit it, and submit a PR. You might not want every section, and you
might want to add extra sections.
You are missing content in this repository that can be helpful for others and you are eager to explain it?
Awesome! We are always happy about new contributions (e.g. elaboration or corrections on certain topics) to this project.
We suggest leaving a comment on the [issue tracker](https://github.com/rust-unofficial/patterns/issues)
so that other people don't start working on the same topic.
We suggest reading our [Contribution guide](./CONTRIBUTION.md) to get more information on how it works.
Correction and elaboration PRs are very welcome.
## Building with mdbook
@ -93,3 +89,8 @@ If you want to build it locally you can run one of these two commands in the roo
Serves the book at `http://localhost:3000` (port is changeable, take a look at the terminal output
to be sure) and reloads the browser when a change occurs.
## License
This content of this repository is licensed under **MPL-2.0**; see [LICENSE](./LICENSE).

@ -12,6 +12,15 @@ A short, prose description of the pattern.
// liberally.
```
When writing examples, please try to make them compile. This allows us to test
them. If you fail to write an example that is both complete and readable,
please at least mark your example code with `ignore` as in here:
```rust,ignore
// A non-runnable example of the pattern in action, should be mostly code, commented
// liberally.
```
## Motivation

Loading…
Cancel
Save