Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

docs: add deprecation notice to readme #20

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

matt-frizzell
Copy link
Contributor

No description provided.

@matt-frizzell matt-frizzell requested a review from a team January 17, 2025 17:12
Copy link

github-actions bot commented Jan 17, 2025

Pull request title looks good 👍!

If this pull request gets merged, it will not cause a new release of the software. Example: If this project's latest release version is 1.0.0. If this pull request gets merged in, the next release of this project will be 1.0.0. This pull request is not a breaking change.

All merged pull requests will eventually get deployed. But some types of pull requests will trigger a deployment (such as features and bug fixes) while some pull requests will wait to get deployed until a later time.

This project uses a special format for pull requests titles. Expand this section to learn more (expand by clicking the ᐅ symbol on the left side of this sentence)...

This project uses a special format for pull requests titles. Don't worry, it's easy!

This pull request title should be in this format:

<type>: short description of change being made

If your pull request introduces breaking changes to the code, use this format:

<type>!: short description of breaking change

where <type> is one of the following:

  • feat: - A feature is being added or modified by this pull request. Use this if you made any changes to any of the features of the project.

  • fix: - A bug is being fixed by this pull request. Use this if you made any fixes to bugs in the project.

  • docs: - This pull request is making documentation changes, only.

  • refactor: - A change was made that doesn't fix a bug or add a feature.

  • test: - Adds missing tests or fixes broken tests.

  • style: - Changes that do not effect the code (whitespace, linting, formatting, semi-colons, etc)

  • perf: - Changes improve performance of the code.

  • build: - Changes to the build system (maven, npm, gulp, etc)

  • ci: - Changes to the CI build system (Travis, GitHub Actions, Circle, etc)

  • chore: - Other changes to project that don't modify source code or test files.

  • revert: - Reverts a previous commit that was made.

Examples:

feat: edit profile photo
refactor!: remove deprecated v1 endpoints
build: update npm dependencies
style: run formatter 

Need more examples? Want to learn more about this format? Check out the official docs.

Note: If your pull request does multiple things such as adding a feature and makes changes to the CI server and fixes some bugs then you might want to consider splitting this pull request up into multiple smaller pull requests.

@matt-frizzell matt-frizzell changed the title docs: Update README.md docs: Updates README for archiving Jan 17, 2025
@matt-frizzell matt-frizzell changed the title docs: Updates README for archiving chore: Updates README for archiving Jan 17, 2025
@matt-frizzell matt-frizzell changed the title chore: Updates README for archiving docs: Updates readme for deprecation Jan 17, 2025
@matt-frizzell matt-frizzell changed the title docs: Updates readme for deprecation docs: add deprecation notice to readme Jan 17, 2025
@matt-frizzell matt-frizzell merged commit d38a6c1 into main Jan 17, 2025
1 of 7 checks passed
@matt-frizzell matt-frizzell deleted the matt-frizzell-archive-repo-readme branch January 17, 2025 21:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants