Skip to content

Commit

Permalink
fix(docs): Telegram link in CONTRIBUTING.md (#731)
Browse files Browse the repository at this point in the history
* chore: fixing Telegram link in CONTRIBUTING.md

* chore: do not repeat contact email

* chore: adding GitHub links to CONTRIBUTING.md
  • Loading branch information
cason authored Jan 6, 2025
1 parent ad2e5df commit 71e19bd
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ If you contribute to this project, your contributions will be made to the projec

The Malachite project adheres to the [Rust Code of Conduct][rust-coc]. This code of conduct describes the minimum behavior expected from all contributors.

Violations of this Code of Conduct can be reported by contacting the team at `[email protected]`.
Violations of this Code of Conduct can be reported by contacting the team at above mentioned contact email.

## Ways to contribute

There are three ways you can contribute to Malachite:

1. **By opening an issue:** For example, if you believe that you have uncovered a bug
in Malachite, creating a new issue in the issue tracker is the way to report it.
2. **By adding context:** Providing additional context to existing issues,
in Malachite, creating a [new issue][new-issue] in the issue tracker is the way to report it.
2. **By adding context:** Providing additional context to [existing issues][existing-issues],
such as screenshots and code snippets to help resolve issues.
3. **By resolving issues:** Typically this is done in the form of either
demonstrating that the issue reported is not a problem after all, or more often,
Expand All @@ -43,11 +43,18 @@ elsewhere.

### Getting Help

If you have reviewed existing documentation and still have questions, or you are having problems, you can get help by *opening a discussion*. This repository comes with a discussion board where we welcome everyone to ask and offer help. Click the "Discussions" tab at the top of the repo.
If you have reviewed existing documentation and still have questions, or you
are having problems, you can get help by [*opening a discussion*][open-discussion].
This repository comes with a [discussion board][discussions-board] where we
welcome everyone to ask and offer help.


_Adapted from the CometBFT and Reth contributing guides._


[rust-coc]: https://www.rust-lang.org/en-US/conduct.html
[tg]: https://t.me/MalachiteLibrary
[tg]: https://t.me/MalachiteEngine
[new-issue]: https://github.com/informalsystems/malachite/issues/new
[existing-issues]: https://github.com/informalsystems/malachite/issues
[open-discussion]: https://github.com/informalsystems/malachite/discussions/new/choose
[discussions-board]: https://github.com/informalsystems/malachite/discussions

0 comments on commit 71e19bd

Please sign in to comment.