- We hope you found this article helpful! If you have any questions or feedback, feel free to reach out to us via
And last but not least, if you found this article useful, please share it with your fellow developers so they can benefit from it as well. Thank you for reading!
diff --git a/src/assets/state/articles/3.jsx b/src/assets/state/articles/3.jsx
index eb5d8db..3d31ab6 100644
--- a/src/assets/state/articles/3.jsx
+++ b/src/assets/state/articles/3.jsx
@@ -48,7 +48,7 @@ export default {
I've personally spent quite a bit of time coming up with features and working out kinks. I would be proud to present them all to you in this post. Make sure to answer some of the questions in the
- Lets get started! + Let's get started!
@@ -56,7 +56,7 @@ export default {- Stashing is a very usefull tool in Git, they allow you to store your progress without having to commit them. This keeps you from accidentally breaking things and can help you stay organized. In applications such as Sourcetree or Github Desktop you can only commit all of your current changes. + Stashing is a very useful tool in Git, they allow you to store your progress without having to commit them. This keeps you from accidentally breaking things and can help you stay organized. In applications such as Sourcetree or Github Desktop you can only commit all of your current changes.
There are actually ways to only stash selected files and even lines. I would like to break this limitation and allow users to organize their stashed by atomically stashing changes whenever it suits them. @@ -79,7 +79,7 @@ export default { />
- My vision for multiple accounts within Commit Rocket is to be able to add it simply throught the settings, and select which account you want in your repository, and it will remember which account you want to commit from forever! This feels like the most convenient way to make use of such a feature, but let me know what you think about it. On a side-note I plan to support at least Github, Gitlab and Bitbucket, others may be added upon request. + My vision for multiple accounts within Commit Rocket is to be able to add it to the settings, and select which account you want in your repository, and it will remember which account you want to commit from forever! This feels like the most convenient way to make use of such a feature but let me know what you think about it. On a sidenote I plan to support at least Github, Gitlab and Bitbucket, others may be added upon request.
- Theming is not necessarily an essential feature, but it does allow people to personalize their experience, which I'm all for! This is why I would like to include a built-in visual editor for your themes, so that you can easily customize it to your liking. In addition I will be adding an export and import feature so that you can share and use other people's themes. + Theming is not necessarily an essential feature, but it does allow people to personalize their experience, which I'm all for! This is why I would like to include a built-in visual editor for your themes, so that you can easily customize it to your liking. In addition, I will be adding an export and import feature so that you can share and use other people's themes.
- By hovering over a commit a small window will pop up showing the changed files. This will help you look for the commits you may want to find quicker and easier. Combining this with being able to see a specific, file's history, and you'd be able to find changes you need in no time. + By hovering over a commit, a small window will pop up showing the changed files. This will help you look for the commits you may want to find quicker and easier. Combining this with being able to see a specific, file's history, and you'd be able to find changes you need in no time.
- Here is my pitch. You have multiple working contexts, like work, school, side-project, etc. You can store your repositories, active theme, accounts, etc. in this context. Then when you switch contexts the repositories, theme, etc. would be retrieved and applied. If you are working on multiple projects then this should keep you more organized. Preferably these contexts would be a 1-click switch, or a hotkey. Unlike VSCode's profiles, you will be able to sync over your settings without having to resort to switching back and forth. + Here is my pitch. You have multiple working contexts, like work, school, side-project, etc. You can store your repositories, active theme, accounts, etc. in this context. Then when you switch contexts the repositories, theme, etc. would be retrieved and applied. If you are working on multiple projects, then this should keep you more organized. Preferably these contexts would be a 1-click switch, or a hotkey. Unlike VSCode's profiles, you will be able to sync over your settings without having to resort to switching back and forth.
- Personally I really like this feature. I have a lot of open repositories at one time, so having a better way to organize them is very welcome. Combining this with themes, could give an extra distinction between your working contexts. I think I would be making use of this a lot. Let me know if you would enjoy this feature! + Personally, I really like this feature. I have a lot of open repositories at one time, so having a better way to organize them is very welcome. Combining this with themes, could give an extra distinction between your working contexts. I think I would be making use of this a lot. Let me know if you would enjoy this feature!
- Which plugins would you be able to install? All sorts of plugins! I personally thought of Scrumboard integrations with Jira, Trello or Devops; Maybe a Vim keybindings plugin; or automatic commit naming using AI. There are a lot of posibilities with this system. + Which plugins would you be able to install? All sorts of plugins! I personally thought of Scrumboard integrations with Jira, Trello or Devops; A Vim key bindings plugin; or automatic commit naming using AI. There are a lot of possibilities with this system.
- In addition I would like to add a plugin marketplace. Maybe something like how the note taking app Obsidian does it, having core plugins and community plugins. + In addition, I would like to add a plugin marketplace. Maybe something like how the note taking app Obsidian does it, having core plugins and community plugins.
- Plugins would work together with the working contexts, by switching which plugin is active between the different contexts. Maybe you don't need a scrumboard active in your side-project context, so you turn it off to save resource and headspace. + Plugins would work together with the working contexts, by switching which plugin is active between the different contexts. What if you don't need a scrumboard active in your side-project context, so you turn it off to save resource and headspace.
I see a lot of potential with plugins, and I hope you do too!
@@ -161,16 +161,16 @@ export default {
src="https://docs.google.com/forms/d/e/1FAIpQLSfabnpc8SWY09GK2mkFeH5XUb3qG6enN-EFaUl_mNcyPbRW-Q/viewform?embedded=true"
width="1920"
height="1650"
- frameborder="0"
- marginheight="0"
- marginwidth="0"
+ frameBorder="0"
+ marginHeight="0"
+ marginWidth="0"
>
Loading survey...
- All of these features are really exciting to me, and are making me hyped for the future of Commit Rocket. These features working together to create an organized, personalized and comfortable experience for all uses sounds like music in my ears. Make sure to participate in the survey, your opinions and ideas will help me a lot as I continue to create Commit Rocket. + All of these features are really exciting to me and are making me hyped for the future of Commit Rocket. These features working together to create an organized, personalized and comfortable experience for all uses sounds like music in my ears. Make sure to participate in the survey, your opinions and ideas will help me a lot as I continue to create Commit Rocket.
That will be all for now, however stay tuned for some upcoming articles about the plugin system, and one about the Commit Rocket techstack. diff --git a/src/assets/state/articles/4.jsx b/src/assets/state/articles/4.jsx new file mode 100644 index 0000000..e374587 --- /dev/null +++ b/src/assets/state/articles/4.jsx @@ -0,0 +1,123 @@ +import { people } from "../team"; +import tags from "./tags"; + +import thumbnail from "@blogImages/4/thumbnail.webp"; +import gitmoji from "@blogImages/4/gitmoji.webp"; +import conventionalcommits from "@blogImages/4/conventionalcommits.webp"; +import logo from "@/assets/images/brand/logo.svg"; + +import A from "@/components/pages/blog/post/ArticleComponents"; + +/** @type {import("./article").default} */ +export default { + title: "Exploring Git Commit Naming Standards", + + thumbnail, + thumbnailAlt: "Anatomy of a Commit Message", + + vertical: "software", + + slug: "git-commit-naming", + + tags: [ + tags.git, + tags.tutorial, + tags.discover, + ], + + author: people.rik, + + created: new Date("2023/06/12"), + + teaser: "Explore the world of Git commit naming standards and learn how to choose the right one for your project", + + content: <> +
+ Personally, I must admit that I haven't always adhered to naming conventions when making Git commits. However, I've come to realize the tremendous benefits they offer, especially when working in teams. Recently, while working on Commit Rocket, I found myself seeking a structured approach to commit naming. +
++ That is why I am writing this article! I would like to find out what makes a great commit message and which standards there are. Also most importantly for me, which approach I could implement in Commit Rocket. I hope to take you along and teach you what I've learned. +
++ From my own experience, I've found that having a structured way to name commits significantly reduces the stress and uncertainty associated with creating commit messages. When you can clearly express the purpose and impact of your changes in a concise manner, it becomes easier to navigate and understand the commit history. It also helps when you need to locate a specific commit later on, whether to review the changes or revert them if needed. +
++ As you can see, a commit message is meant to convey some sort of meaning. Having standardized ways to write these messages means that everyone will be on the same page. +
++ It's important to use the imperative mood, which provides a clear instruction about what the commit does. Instead of saying "I added feature XYZ," it should be "Add feature XYZ." This small change in phrasing makes a big difference in creating a consistent and actionable commit history. +
++ Commit messages should be detailed enough to convey the purpose and context of the changes. When writing commit messages ask yourself why the changes were made, what the context is of the changes and what effect it will have. +
++ While a short one-liner can work in some cases, using multi-paragraph messages can provide a more in-depth explanation, especially for complex or significant changes. If you're using the Git command-line interface, you can achieve this by adding an extra `-m` flag to the commit command. Here is an example: +
++ The length of a commit message is also important. Aim for around 50 to 75 characters to keep it concise and readable. Avoid using filler words or unnecessary details like "I think" or "maybe." Instead, focus on conveying the essence of the change in a clear and straightforward manner. +
++ There are several widely adopted naming conventions that can serve as helpful guidelines for crafting effective commit messages. Here are two popular options: +
++ This convention provides a structured format for commit messages, including optional scopes, a description, body, and footer(s). For example: +
++ Conventional Commits offer an easy-to-understand and versatile format that can be quickly adopted and applied to your projects. +
++ Gitmoji introduces emojis to commit messages, giving them a visually appealing touch. It follows a format that includes an intention, an optional scope, and a message. For example: +
++ While Gitmoji brings a fun and expressive aspect to commit messages, it may take some time to get used to its unique set of emojis and their meanings. +
++ The Commit Rocket repository will likely be making use of Gitmoji. It will take some getting used to for people, but I think it is a neat and clean way to express code changes. I also think that adding a visual aspect to commits is a fun idea. Maybe adding template commit names to Commit Rocket will be helpful 🤔. +
++ Remember, commit naming conventions are just tools to help us communicate effectively and collaborate smoothly within our projects. While there are various conventions to choose from, the most important thing is to adopt one that works well for you and your team. +
+ +}; \ No newline at end of file diff --git a/src/assets/state/articles/index.ts b/src/assets/state/articles/index.ts index 3343a17..aeb7e92 100644 --- a/src/assets/state/articles/index.ts +++ b/src/assets/state/articles/index.ts @@ -3,6 +3,7 @@ import IArticle from "./article"; import article1 from "./1"; import article2 from "./2"; import article3 from "./3"; +import article4 from "./4"; export default [ { @@ -16,5 +17,9 @@ export default [ { filename: "3", article: article3 + }, + { + filename: "4", + article: article4 } ] as { filename: string; article: IArticle }[]; \ No newline at end of file diff --git a/src/assets/state/articles/tags.ts b/src/assets/state/articles/tags.ts index db0da03..43da843 100644 --- a/src/assets/state/articles/tags.ts +++ b/src/assets/state/articles/tags.ts @@ -21,5 +21,8 @@ export default { }, "plans": { name: "Plans" + }, + "discover": { + name: "Discover" } } satisfies Record- (Coming Soon™) + (In the future™) , icon: DiscordIcon, diff --git a/src/assets/state/roadmap.tsx b/src/assets/state/roadmap.tsx index 5650b0d..6266dec 100644 --- a/src/assets/state/roadmap.tsx +++ b/src/assets/state/roadmap.tsx @@ -10,7 +10,7 @@ export interface IRoadmapItem { // NOTE: This list is assumed to be in order export default [ { - title: "Q2 2023", + title: "Q3 & Q4 2023", text: <>
- To encourage an active community, we plan to launch a public Discord server where users can freely exchange ideas and communicate directly with the development team. -
Early access versions of Commit Rocket will be made available exclusively to our mailing list subscribers and Discord members. - To ensure a smooth user experience, we encourage users to share their feedback and feature requests with us via our Discord server and our email. + To ensure a smooth user experience, we encourage users to share their feedback and feature requests with us via our our feedback form. As the product is still subject to changes, we appreciate our users' contributions in helping us shape the final product.
- After the alpha release, we will continue to enhance Commit Rocket by taking feedback from our users and working on the client. - Though we have not set specific goals, we aim to develop a stable and production-ready application by the end of the year. -
- } ] satisfies IRoadmapItem[]; \ No newline at end of file diff --git a/src/assets/state/team.tsx b/src/assets/state/team.tsx index 0301428..4a1795f 100644 --- a/src/assets/state/team.tsx +++ b/src/assets/state/team.tsx @@ -27,10 +27,6 @@ export const people = { href: "https://github.com/Rikthepixel", name: "GitHub" }, - { - href: "mailto:rikdenbreejen@commitrocket.com", - name: "Email" - }, { href: "https://www.rikdenbreejen.nl", name: "Website" @@ -38,6 +34,10 @@ export const people = { { href: "https://www.linkedin.com/in/rik-den-breejen-a84aa71a7/", name: "LinkedIn" + }, + { + href: "https://www.youtube.com/@RikThePixel", + name: "Youtube" } ] } diff --git a/src/components/content/CodeBlock/index.tsx b/src/components/content/CodeBlock/index.tsx index 0977ccb..7c12551 100644 --- a/src/components/content/CodeBlock/index.tsx +++ b/src/components/content/CodeBlock/index.tsx @@ -15,7 +15,7 @@ export interface CodeBlockProps { /** * The code */ - children: string; + children: string | string[]; /** * To style the `pre` tag @@ -67,11 +67,11 @@ const CodeBlock: React.FC
-
+
{renderedLines}
diff --git a/src/components/controls/Form.tsx b/src/components/controls/Form.tsx
index f85e58b..3af3441 100644
--- a/src/components/controls/Form.tsx
+++ b/src/components/controls/Form.tsx
@@ -15,7 +15,7 @@ const Form = ({
children,
successChildren,
success,
- successClassName = "p-8 my-8 text-xl font-semibold rounded-2xl border-2 border-green-600 w-fit mx-auto image-dots bg-green-400 from-green-600",
+ successClassName = "p-8 my-8 text-xl font-semibold rounded-2xl w-fit mx-auto image-star bg-green-500",
successProps,
oneTime,
...props
diff --git a/src/components/layout/Footer.tsx b/src/components/layout/Footer.tsx
index fb2ad2b..6a0fdd5 100644
--- a/src/components/layout/Footer.tsx
+++ b/src/components/layout/Footer.tsx
@@ -5,8 +5,8 @@ import Logo from "@/assets/images/brand/logo.svg";
const Footer = () => {
return (
-