Skip to content

Clean up README and add docs for each analyzer rule #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MattKotsenas merged 7 commits into from
Jun 10, 2024
Merged

Clean up README and add docs for each analyzer rule #77

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b030c04
Hard wrap README
MattKotsenas Jun 10, 2024
dd05016
Move code of conduct to CODE-OF-CONDUCT.md so GitHub can pick it up
MattKotsenas Jun 10, 2024
825c59b
Create CONTRIBUTING.md to GitHub can pick it up
MattKotsenas Jun 10, 2024
b677434
Copy edit installation section
MattKotsenas Jun 10, 2024
d6a79d0
Copy edit intro
MattKotsenas Jun 10, 2024
1949ec5
Add badges to intro
MattKotsenas Jun 10, 2024
aa116fb
Add docs for each analyzer rule
MattKotsenas Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Create CONTRIBUTING.md to GitHub can pick it up
  • Loading branch information
@MattKotsenas
MattKotsenas committed Jun 10, 2024
commit 825c59b50061d3bfd54c6e5537d09e49b0a9f178
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing

We welcome contributions. If you want to contribute to existing issues, check the
[help wanted](https://github.com/rjmurillo/moq.analyzers/labels/help%20wanted) or
[good first issue](https://github.com/rjmurillo/moq.analyzers/labels/good%20first%20issue) items in the backlog.

If you have new ideas or want to complain about bugs, feel free to [create a new issue](https://github.com/rjmurillo/moq.analyzers/issues/new).
9 changes: 2 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,7 @@ Install ["Moq.Analyzers" NuGet package](https://www.nuget.org/packages/Moq.Analy

You must use an in-support version of the .NET SDK (i.e. 6+).

## Contributions are welcome!
## Contributions welcome

Moq.Analyzers continues to evolve and add new features. Any help will be appreciated. You can report issues,
develop new features, improve the documention, or do other cool stuff.

If you want to contribute to existing issues, check the
[help wanted](https://github.com/rjmurillo/moq.analyzers/labels/help%20wanted) or
[good first issue](https://github.com/rjmurillo/moq.analyzers/labels/good%20first%20issue) items in the backlog.
If you have new ideas or want to complain about bugs, feel free to [create a new issue](https://github.com/rjmurillo/moq.analyzers/issues/new).
develop new features, improve the documentation, or do other cool stuff. See [CONTRIBUTING.md](./CONTRIBUTING.md).