diff --git a/content/blog/itsdangerous-1-1-0-released.md b/content/blog/itsdangerous-1-1-0-released.md index a847a09..a58c22d 100644 --- a/content/blog/itsdangerous-1-1-0-released.md +++ b/content/blog/itsdangerous-1-1-0-released.md @@ -8,11 +8,11 @@ tags = ["releases"] itsdangerous 1.1.0 has been released to fix compatibility issues that were affecting projects while upgrading. Due to these issues, we had to make a quick decision and pull itsdangerous 1.0.0 from PyPI earlier today to prevent more -projects from being affected. We appologize for the difficulty this caused, and -the changes in this release should address compatibilty going forward. +projects from being affected. We apologize for the difficulty this caused, and +the changes in this release should address compatibility going forward. 1.0.0 changed the default digest algorithm from SHA-1 to SHA-512. SHA-1 as used -by itsdangerous was never suceptible to the collision issue published last year, +by itsdangerous was never susceptible to the collision issue published last year, but the change was made for peace of mind. However, this change invalidated existing signatures that were in use. @@ -28,7 +28,7 @@ Additionally, we reverted a change to the project name in setup.py. 1.0.0 changed the capitalization from "itsdangerous" to "ItsDangerous", but this caused issues with some systems. The name will remain as "itsdangerous". -We appologize again for the issues and thank everyone in the community who +We apologize again for the issues and thank everyone in the community who contributed to the discussion. ## Upgrade diff --git a/content/contributing/questions.md b/content/contributing/questions.md index 32f1e3b..f195992 100644 --- a/content/contributing/questions.md +++ b/content/contributing/questions.md @@ -52,7 +52,7 @@ people will want to ask and participate, and our community will grow. Try to answer questions directly and politely. After answering the immediate question, it's fine to suggest other improvements, or ask followup -questions. Avoid being overwhelming or judgemental. Avoid phrases like "just do this", "it's obvious", +questions. Avoid being overwhelming or judgmental. Avoid phrases like "just do this", "it's obvious", "why would you do that", etc. Remember, everyone is at a different stage of learning, and you were there once as well. diff --git a/content/contributing/release.md b/content/contributing/release.md index aa0c6c4..28065b9 100644 --- a/content/contributing/release.md +++ b/content/contributing/release.md @@ -150,7 +150,7 @@ make all change log files Markdown to avoid this issue. **Never use GitHub's "Generate release notes" feature.** Copying each commit message/PR title is not helpful compared to the curated change log we produce. -Additionally, the pings it adds for each contribtor can become spammy, +Additionally, the pings it adds for each contributor can become spammy, especially if mirrors/bots pick up the release and copy it into other issues/commits, which _has_ happened in the past. @@ -166,7 +166,7 @@ Close the milestone. Click the link to the milestone from the PR, click "Edit", then click "Close". Merge the PR. **Make sure the "create a merge commit" strategy is selected.** -Using the "sqaush" or "rebase" strategies will cause the tagged commit to be out +Using the "squash" or "rebase" strategies will cause the tagged commit to be out of sync with the repo. Remember, you tagged the _specific_ commit in the PR, squashing or rebasing would re-create that commit so the tag would no longer be valid. This is recoverable with difficulty, but don't let it happen. @@ -195,7 +195,7 @@ can defer doing all this until at least one issue is reported. 4. Commit the changes with the message `start version A.B.C+1` 5. Push this commit, no need to create a PR. 3. Merge `stable` into `main`. Make sure the new change log section is merged - _below_ the section for the next feature relase, and that the version isn't + _below_ the section for the next feature release, and that the version isn't overwritten. 4. Push `main`.