Skip to content

Commit

Permalink
update contributing docs (#38)
Browse files Browse the repository at this point in the history
create `CONTRIBUTING.md` and update contributing docs
  • Loading branch information
kiraware authored Jul 25, 2024
1 parent f7cf855 commit 804e1cc
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contributing to paspybin

Thank you for your interest in contributing to paspybin!
We welcome contributions from everyone. Before you get
started, please take a moment to review the following
guidelines.

## How to Contribute

To learn how to contribute to paspybin, please refer to
our [Contributing Guide](https://paspybin.readthedocs.io/en/latest/how-to-guides/#contributing)
on the paspybin documentation site.
29 changes: 28 additions & 1 deletion docs/how-to-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

## Contributing

Thank you for your interest in contributing to paspybin!
We welcome contributions from everyone. Before you get
started, please take a moment to review the following
guidelines.

### Code of Conduct

Please note that this project adheres to the Contributor
Covenant Code of Conduct. By participating, you are
expected to uphold this code. Please report any
unacceptable behavior.

### Ways to Contribute

Here are a few ways you can contribute to paspybin:

- Reporting bugs
- Suggesting new features
- Writing or improving documentation
- Submitting bug fixes or enhancements via Pull Requests

### Getting Started

You can contribute directly to paspybin by submit a pull
Expand Down Expand Up @@ -58,7 +79,8 @@ dependency with the following command:
poetry install
```

And done! You can contribute directly by getting your hands wet.
And done! You can make your changes and test thoroughly.
Then push your branch to your fork and submit a pull request.

!!! tip
If you have installed [poethepoet](https://poethepoet.natn.io/index.html)
Expand Down Expand Up @@ -155,3 +177,8 @@ release to GitHub. The special environment for people who have access
to the workflow is in the GitHub environment with the name `production`.
Each release tag must be the same as `version` in `pyproject.toml` in
the `tool.poetry` section.

### License

By contributing to paspybin, you agree that your contributions will be
licensed under the project's [MIT License](https://github.com/kiraware/paspybin/blob/main/LICENSE).

0 comments on commit 804e1cc

Please sign in to comment.