Skip to content

Commit

Permalink
Contributing guide polish
Browse files Browse the repository at this point in the history
  • Loading branch information
Alon Kellner committed Jul 10, 2024
1 parent ff25b7f commit d2b70b3
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 15 deletions.
21 changes: 18 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

We redpect our community, all contributions must adhere to our [Code Of Conduct](CODE_OF_CONDUCT.md).
We respect our community, all contributions must adhere to our [Code Of Conduct](CODE_OF_CONDUCT.md).

## The Very First Contribution

Expand All @@ -10,14 +10,29 @@ There is one way in which you can contribute that takes only one second:

Even if you do not give a star, you are the best!
Using WaloViz, telling a friend about it or making contributions are all amazing ways in which WaloViz can become more useful for more people.
For that we are greatful :heart:
For that we are grateful :heart:

## What is a Good First Contribution?

The best place to start contributing to WaloViz is always the [Good First Issues](https://github.com/AlonKellner/waloviz/issues?q=is%3Aissue+is%3Aopen+%3Agood-first-issue)!
These are issues tagged with the `good-first-issue` tag, and you should be able to tackle them without any prior knowledge.

But before you go ahead and start working on a PR you should read our [Developer Guide](DEVELOPER-GUIDE.md) first.
But before you go ahead and start working on a PR you should finish this guide, and also read our [Developer Guide](DEVELOPER-GUIDE.md).

## PR Checklist

Before starting to work on any PR go through this checklist, and once more before submitting.

- [ ] **Is there an Issue corresponding to my PR?** - If not, [Create an Issue](https://github.com/AlonKellner/waloviz/issues/new).
- [ ] **Does any maintainer know I'm working on this?** - If not, [LET THEM KNOW](https://github.com/AlonKellner/waloviz/issues)!
- [ ] **Did my suggestion got rejected?** - If so, it's nothing personal, we still appreciate you :) Try finding something else to contribute, perhaps [an already open Issue](https://github.com/AlonKellner/waloviz/issues) that was accepted but not solved.
- [ ] **Are there any difficult decisions I need to make?** - Talk about them in your [corresponding Issue](https://github.com/AlonKellner/waloviz/issues).
- [ ] **Did I add my changes to the next release in the [`doc/releases.md`](doc/releases.md)?** - If not, add them.
- [ ] **Should my changes be documented in the website?** - If so, document it in the `doc/`.
- [ ] **Should my changes have any tests?** - If so, write them in `tests/`.
- [ ] **Does `pre-commit run` passes?** - If not, try to run it again and see if it passes now.
- [ ] **Does `pytest tests/ui --browser chromium`** - passes? If not, make those tests pass before submitting.
- [ ] **Did anyone respond to my PR or Issue?** - If not, don't worry, we probably missed it by mistake, sorry... Just write another comment and mention a maintainer.

## Can I Contribute more?

Expand Down
12 changes: 1 addition & 11 deletions DEVELOPER-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,6 @@ Now follow these steps:
2. Reopen folder in Dev Container (`ctrl+shift+P` -> type "Reopen", this may take a few minutes)
3. `git checkout develop`

## PR Checklist

- [ ] Is there an Issue corresponding to my PR? If not, [Create an Issue](https://github.com/AlonKellner/waloviz/issues/new).
- [ ] Does any maintainer know I'm working on this? If not, [LET THEM KNOW](https://github.com/AlonKellner/waloviz/issues)!
- [ ] Did I add my changes to the next release in the [`doc/releases.md`](doc/releases.md)? If not, add them.
- [ ] Should my changes be documented in the website? If so, document it in the `doc/`.
- [ ] Does `pre-commit run` passes? If not, try to run it again and see if it passes now.
- [ ] Does `pytest tests/ui --browser chromium` passes? If not, make those tests pass before submitting.
- [ ]

## Where is Stuff?

The Repository Structure is like so:
Expand Down Expand Up @@ -67,4 +57,4 @@ In this repo there are many technologies for different usages, here is a list wi
### YES

You Are READY.
A truly certified Contributor, **thank you**, what a wonder you are :)
What a wonder you are, a truly Certified Contributor, **thank you :)**
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To learn more read our [Getting Started Guide](https://waloviz.com/en/latest/get

## [Documentation](https://waloviz.com)

[Our Docs](https://waloviz.com) are generated by [sphinx](https://www.sphinx-doc.org/en/master/) and [`nbsite`](https://nbsite.holoviz.org/) and hosted by [readthedocs](https://docs.readthedocs.io/en/stable/).
[Our Docs](https://waloviz.com) are generated by [Sphinx](https://www.sphinx-doc.org/en/master/) and [NBSite](https://nbsite.holoviz.org/) and hosted by [Read the Docs](https://docs.readthedocs.io/en/stable/).

## [Contributing](CONTRIBUTING.md)

Expand Down

0 comments on commit d2b70b3

Please sign in to comment.