Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Various improvements to CONTRIBUTING.md #1009

Merged
merged 13 commits into from
Nov 22, 2022
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,4 @@ ingestion_server/ingestion_server/db
ingestion_server/ingestion_server/lock
.vscode

openapi.yaml
openapi.yaml
Yash-Pratapwar marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ By participating in this project, you are expected to uphold our [Code of Conduc

## Project Documentation

Please consult the [README](./README.md) and [CODEBASE](./CODEBASE.md) files at the root of this repository.

Please consult the [README](./README.md) file at the root of this repository.
Also see the [project documentation guidelines](./DOCUMENTATION_GUIDELINES.md) if you are interested in improving our documentation.
Yash-Pratapwar marked this conversation as resolved.
Show resolved Hide resolved
### Bugs

If you find a bug, please open an issue in this repository describing the bug. You can file a bug [here](https://github.com/WordPress/openverse-api/issues/new?template=bug_report.md). You will see a bug report template with the required information you should provide.
Expand All @@ -18,7 +18,7 @@ After that, don't forget to tag the issue with the "Bug" label.

### Proposing changes or new features

If you have an idea of a new feature or change to how the Openverse API works, please [start a discussion](https://github.com/WordPress/openverse-api/discussions/new?category=ideas) so we can discuss the possibility of that change or new feature being implemented and released in the future. This lets us come to an agreement about the proposed idea before any work is done.
Feel free to [open an issue](https://github.com/WordPress/openverse-api/issues/new/choose) to discuss any new features or to propose any changes.

### Pull requests

Expand Down Expand Up @@ -94,4 +94,4 @@ python3 test/integration_tests.py

## Questions or Thoughts?

Feel free to [join us on Slack](https://make.wordpress.org/chat/) and discuss the project with the engineers and community members on #openverse. We also use [GitHub discussions](https://github.com/WordPress/openverse-api/discussions) for feature requests, troubleshooting, and other 'off-topic' conversations.
Feel free to [join us on Slack](https://make.wordpress.org/chat/) and discuss the project with the engineers and community members on #openverse.
11 changes: 11 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[[source]]
Yash-Pratapwar marked this conversation as resolved.
Show resolved Hide resolved
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]

[dev-packages]

[requires]
python_version = "3.8"
20 changes: 20 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.