diff --git a/files/en-us/mdn/community/issues/index.md b/files/en-us/mdn/community/issues/index.md index 9e42ffa10ff14a3..11b1ee88d177b9c 100644 --- a/files/en-us/mdn/community/issues/index.md +++ b/files/en-us/mdn/community/issues/index.md @@ -82,27 +82,52 @@ The task list in this issue will be used to compare the documented CSS propertie ## Guidelines for working on an issue -Remember that if you take on an issue, the expectation is for the work to be completed in a timely manner. If you're not able to make any progress for a week after being assigned or can no longer complete the required task, leave a comment and unassign yourself from the issue. +Remember that if you take on an issue, the expectation is for the work to be completed in a timely manner. +If you are unable to progress work on a claimed issue, please add a comment so that maintainers are aware, and so that the issue can be picked up by another contributor. These are the general steps for working on an issue: -1. **Find an issue:** If you're looking to contribute, search for issues with [`good first issue`, `help wanted`](#set_other_labels) or [`p3`](#set_a_priority_label) label. Most repositories have issues with these labels. You are welcome to browse and pick an issue that is suitable for your skill set. Another useful place to look for issues to work on is the [MDN Contributors Task Board](https://github.com/orgs/mdn/projects/25). This project view lists open issues from multiple repositories. You can filter the list based on the topics (`Labels` column) you're interested in. See the description of some of the [labels](#set_other_labels) that get applied during the issue triage process. +1. **Find an issue:** + + If you're looking to contribute, search for issues with a [`good first issue`, `help wanted`](#set_other_labels) or [`p3`](#set_a_priority_label) label. Most repositories have issues with these labels. You are welcome to browse and pick an issue that is suitable for your skill set. Another useful place to look for issues to work on is the [MDN Contributor Board](https://github.com/orgs/mdn/projects/25). This project view lists open issues from multiple repositories. You can filter the list based on the topics (`Labels` column) you're interested in. See the description of some of the [labels](#set_other_labels) that get applied during the issue triage process. > [!NOTE] > An issue with the `needs triage` label indicates that the MDN Web Docs core team has not reviewed the issue yet, and you shouldn't begin work on it. -2. **Assign the issue to yourself:** After finding an issue you'd like to work on, make sure that the issue is not assigned to anybody else. Add a comment saying you would like to work on the issue, and if you are able to, [assign the issue to yourself](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users#assigning-an-individual-issue-or-pull-request). +2. **Check that no one is already working on the issue:** + + Before starting work on an issue, first check that no one is assigned to the issue (the _Assignees_ field should be "Unassigned"). + + Then check that there are no linked [Pull Requests](/en-US/docs/MDN/Community/Pull_requests), as these may indicate that another contributor has claimed the issue and started working on it. + +3. **Do the research:** + + Most issues need some investigation before work can start. + - Scope out the work that needs to be done. + If the issue is not well-described, and/or you are not sure what is needed, feel free to mention the person who opened the issue (using @username) and ask for more clarifying information. + - You can also ask for advice in the [MDN Web Docs chat rooms](/en-US/docs/MDN/Community/Communication_channels#chat_rooms). + +4. **Claim the issue:** + + You can "claim" an unassigned and unclaimed issue by following these steps: + 1. Fork the repository and create your working branch. + 2. Fix the issue and then open a [Pull Request (PR)](/en-US/docs/MDN/Community/Pull_requests) in the repository. + 3. In the PR description, include the text `Fixes #` (if the PR only partially fixes the issue add the text `Related to #`). + + Adding this text is what creates a cross-reference between the issue and the PR, and implicitly marks the issue as claimed by you. + + > [!NOTE] + > If you have the necessary permissions, you should also _explicitly_ [assign the issue to yourself](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users#assigning-an-individual-issue-or-pull-request). -3. **Do the research:** Most issues need some investigation before work can start. - - Scope out the work that needs to be done. If you need to ask questions, ask them in the [MDN Web Docs chat rooms](/en-US/docs/MDN/Community/Communication_channels#chat_rooms). - - If the issue is well-described, and the work is pretty obvious, go ahead and do it. - - If the issue is not well-described, and/or you are not sure what is needed, feel free to @mention the poster and ask for more information. + Depending on the files you've updated in the pull request, a reviewer will be assigned to your pull request automatically. (Teams per topic area are defined in the [CODEOWNERS](https://github.com/mdn/content/blob/main/.github/CODEOWNERS) file). -4. **Make the changes:** Fork and branch the repository. Do your work and open a [pull request](/en-US/docs/MDN/Community/Pull_requests) in the repository. [Reference the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue) in the pull request description. Depending on the files you've updated in the pull request, a reviewer will be assigned to your pull request automatically. (Teams per topic area are defined in the [CODEOWNERS](https://github.com/mdn/content/blob/main/.github/CODEOWNERS) file). + > [!WARNING] + > After opening the pull request, if you find you no longer have the time to make changes or incorporate review feedback, let the team know as soon as possible in a comment in the pull request. + > This will help the team assign another interested contributor to complete the work on the pull request and close the linked issue. - After opening the pull request, if you find you no longer have the time to make changes or incorporate review feedback, let the team know as soon as possible in a comment in the pull request. This will help the team assign another interested contributor to complete the work on the pull request and close the linked issue. +5. **Close the issue as completed:** -5. After your pull request has been reviewed and merged, you can mark the linked issue as closed. If you opened the pull request with `Fixes #` verbiage, the issue will be closed automatically when the pull request is merged. + If you opened the pull request with `Fixes #` in the description, the issue will be closed automatically when the PR is merged. Otherwise, you can add a comment to the issue linking to one or more pull requests that fix it, and a maintainer will close the issue as completed. ### Fixing issues yourself diff --git a/files/en-us/web/http/reference/status/204/index.md b/files/en-us/web/http/reference/status/204/index.md index d808302178e3956..dc9055a6ad3ace3 100644 --- a/files/en-us/web/http/reference/status/204/index.md +++ b/files/en-us/web/http/reference/status/204/index.md @@ -46,6 +46,33 @@ Date: Wed, 26 Jun 2024 12:00:00 GMT Server: Apache/2.4.1 (Unix) ``` +### Receiving a response after updating with PUT + +In this example, the client sends a `PUT` request to update a user's profile information. +The request includes an {{HTTPHeader("Authorization")}} header with a token to authenticate the request: + +```http +PUT /users/123 HTTP/1.1 +Host: example.com +Content-Type: application/json +Authorization: Bearer 1234abcd + +{ + "name": "Jane Doe", + "email": "jane@example.com" +} +``` + +After successfully updating the user profile, the server responds with a `204` response. +The {{HTTPHeader("ETag")}} header contains the entity tag for the updated resource: + +```http +HTTP/1.1 204 No Content +Date: Wed, 26 Jun 2024 12:00:00 GMT +ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4" +Server: Apache/2.4.1 (Unix) +``` + ## Specifications {{Specifications}}