[PR #1135] [CLOSED] Update Directions and Content of CONTRIBUTING.md #1177

New issue

Closed

opened 2026-02-28 00:03:57 +03:00 by kerem · 0 comments

kerem commented

2026-02-28 00:03:57 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/1135
Author: @bennetthamilton
Created: 6/11/2024
Status: ❌ Closed

Base: master ← Head: master

📝 Commits (2)

ca76ebc add sections for forking, pull requests, and authors/contributors
9ac7da0 update change log with proposed changes

📊 Changes

2 files changed (+66 additions, -2 deletions)

View changed files

📝 CHANGELOG.md (+2 -0)
📝 CONTRIBUTING.md (+64 -2)

📄 Description

Resolves #1124

I contributed to the project’s documentation by updating the CONTRIBUTING.md document. The ‘contributing.md’ is intended to give instructions to developers on how to make changes. However, it does not give very detailed instructions on how to fork and make pull requests. Existing instructions are not very clear for beginner developers.

In addition, there is an inconsistency between their repo and main website. The main website has a list of authors/contributors under the “Contribute” section which is missing in corresponding document.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/spotipy-dev/spotipy/pull/1135 **Author:** [@bennetthamilton](https://github.com/bennetthamilton) **Created:** 6/11/2024 **Status:** ❌ Closed **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (2) - [`ca76ebc`](https://github.com/spotipy-dev/spotipy/commit/ca76ebc3c1ecec9f9f671dc9f639e19aefaeb7c8) add sections for forking, pull requests, and authors/contributors - [`9ac7da0`](https://github.com/spotipy-dev/spotipy/commit/9ac7da06e584e3da683824603bbae33c90a31d25) update change log with proposed changes ### 📊 Changes **2 files changed** (+66 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+2 -0) 📝 `CONTRIBUTING.md` (+64 -2) </details> ### 📄 Description Resolves #1124 I contributed to the project’s documentation by updating the [CONTRIBUTING.md](https://github.com/spotipy-dev/spotipy/blob/master/CONTRIBUTING.md) document. The ‘contributing.md’ is intended to give instructions to developers on how to make changes. However, it does not give very detailed instructions on how to fork and make pull requests. Existing instructions are not very clear for beginner developers. In addition, there is an inconsistency between their repo and main [website](https://spotipy.readthedocs.io/en/2.24.0/#contribute). The main website has a list of authors/contributors under the “Contribute” section which is missing in corresponding document. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>