Skip to content

Commit

Permalink
Update contributing.md and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
detrumi committed Dec 3, 2019
1 parent 3ef2030 commit b788175
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 29 deletions.
50 changes: 23 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,24 @@
*Note that this `Contribution.md` document is more or less a copy of the file
with the same name of the [Rust compiler](https://github.com/rust-lang/rust)
project.*

# Contributing to chalk

Thank you for your interest in contributing to chalk! There are many ways to
contribute, and we appreciate all of them.

* [Feature Requests](#feature-requests)
* [Bug Reports](#bug-reports)
* [Running and Debugging](#running-and-debugging)
* [Pull Requests](#pull-requests)
* [Writing Documentation](#writing-documentation)
* [Issue Triage](#issue-triage)
* [Helpful Links and Information](#helpful-links-and-information)

If you have questions, please join [our gitter channel](https://gitter.im/chalk-rs/Lobby).
If you'd like to contribute, consider joining the [Traits Working Group][traits-working-group].
We hang out on the [rust-lang zulip][rust-lang-zulip] in the [#wg-traits][wg-traits-stream] stream.

As a reminder, all contributors are expected to follow our [Code of Conduct][coc].

[pound-rust-internals]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
[internals]: https://internals.rust-lang.org
[traits-working-group]: https://rust-lang.github.io/compiler-team/working-groups/traits/
[rust-lang-zulip]:https://rust-lang.zulipchat.com
[wg-traits-stream]: https://rust-lang.zulipchat.com/#narrow/stream/144729-wg-traits
[coc]: https://www.rust-lang.org/conduct.html

## Feature Requests
[feature-requests]: #feature-requests

To request a change to the way that the Rust language works, please open an
issue in the [RFCs repository](https://github.com/rust-lang/rfcs/issues/new)
rather than this one. New features and other significant language changes
must go through the RFC process.

## Bug Reports
[bug-reports]: #bug-reports

Expand All @@ -50,25 +39,32 @@ other than `0`. The easiest way to do this is to invoke `chalk` like this:
$ RUST_BACKTRACE=1 chalk ...
```

### Building
[building]: #building
## Running and Debugging
[running-and-debugging]: #running-and-debugging
There is a repl mainly for debugging purposes which can be run by `cargo run`. Some basic examples are in [libstd.chalk](libstd.chalk):
```bash
$ cargo run
?- load libstd.chalk
?- Vec<Box<i32>>: Clone
Unique; substitution [], lifetime constraints []
```

Chalk has to be build with the nightly version of the rust compiler.
More logging can be enabled by setting the `CHALK_DEBUG` environment variable. Set `CHALK_DEBUG=1` to see `info!(...)` output, and `CHALK_DEBUG=2` to see `debug!(...)` output as well.

## Pull Requests
[pull-requests]: #pull-requests

Pull requests are the primary mechanism we use to change Rust. GitHub itself
has some [great documentation][pull-requests] on using the Pull Request feature.
has some [great documentation][pull-request-documentation] on using the Pull Request feature.
We use the "fork and pull" model [described here][development-models], where
contributors push changes to their personal fork and create pull requests to
bring those changes into the source repository.

[pull-requests]: https://help.github.com/articles/about-pull-requests/
[development-models]: https://help.github.com/articles/about-collaborative-development-models/

Please make pull requests against the `master` branch.

[pull-request-documentation]: https://help.github.com/articles/about-pull-requests/
[development-models]: https://help.github.com/articles/about-collaborative-development-models/

## Writing Documentation
[writing-documentation]: #writing-documentation

Expand All @@ -79,16 +75,16 @@ You can find documentation style guidelines in [RFC 1574][rfc1574].

[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text

# Helpful Links and Information
## Helpful Links and Information
[Helpful Links and Information]: #helpful-links-and-information

## Blog posts
### Blog posts
There are several [blog posts][blog-posts] which describe the ideas and
machinery inside of chalk.

[blog-posts]: README.md#blog-posts

## Glossary
### Glossary

In addition to the blog posts there is a [glossary](GLOSSARY.md) explaining some
of the terminology used in chalk.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,21 @@ Here are some blog posts talking about chalk:

## REPL

There is a repl mainly for debugging purposes which can be run by `cargo run`. Some basic examples are in [libstd.chalk](libstd.chalk).
There is a repl mainly for debugging purposes which can be run by `cargo run`. Some basic examples are in [libstd.chalk](libstd.chalk):
```bash
$ cargo run
?- load libstd.chalk
?- Vec<Box<i32>>: Clone
Unique; substitution [], lifetime constraints []
```

## Contributing

If you're like to contribute, consider joining the [Traits Working Group](https://rust-lang.github.io/compiler-team/working-groups/traits/). We hang out on the [rust-lang zulip](https://rust-lang.zulipchat.com) in the [#wg-traits](https://rust-lang.zulipchat.com/#narrow/stream/144729-wg-traits) and [#wg-rls-2.0/chalk](https://rust-lang.zulipchat.com/#narrow/stream/191167-t-compiler.2Fwg-rls-2.2E0.2Fchalk) streams.
If you'd like to contribute, consider joining the [Traits Working Group][working-group].
We hang out on the [rust-lang zulip][rust-lang-zulip] in the [#wg-traits][wg-traits-stream] stream.

See [CONTRIBUTING.md](CONTRIBUTING.md) for more info.

[working-group]: https://rust-lang.github.io/compiler-team/working-groups/traits/
[rust-lang-zulip]:https://rust-lang.zulipchat.com
[wg-traits-stream]: https://rust-lang.zulipchat.com/#narrow/stream/144729-wg-traits

0 comments on commit b788175

Please sign in to comment.