Committing changes

Sequential steps to be followed when using this skill

When committing changes, follow those steps.

Create the committing-changes Execution Checklist (MANDATORY)

• Before executing anything, create a checklist named committing-changes Execution Checklist with all steps of these instructions.
• The committing-changes Execution Checklist must include all numbered steps explicitly.
• After completing each step of these instructions, mark the item in the committing-changes Execution Checklist as completed.
• Do not skip any item.
• If an item cannot be executed, explicitly explain why.
• Never mark the task as completed while any item from the committing-changes Execution Checklist remains open.

1. Inform the user

• Always tell the user "SKILL: I am committing changes" to inform the user that you are running this skill.

2. Stage all the files that should be part of the commit

• Identify all the files that make sense to commit altogether as part of 1 commit.
• Always use cli: git add {file1} {file2} ... {fileN} to stage those identified files.
• Never use cli: git add --all, because some files may be modified by the user and should not be part of your commit.

Example:

git add lib/my_lib/my_class.rb README.md

3. Create a temporary file with the commit description

• Devise a meaningful commit comment that summarizes the changes you are going to commit.
• Always use agent: write_to_file tool to write the commit comment in a temporary file (later referenced as {description_file}), inside the directory .x_aeon_agents/tmp/commits.

4. Create the commit

• Find this skill directory path, later referenced as {skill_path}.
• Always use cli: ruby {skill_path}/scripts/commit {description_file} to create the git commit.
• Never use cli: git commit directly.

Example:

ruby .cline/skills/committing-changes/scripts/commit .x_aeon_agents/tmp/commits/commit_desc.txt

5. Delete the temporary commit description file

• Always delete the temporary description file {description_file} once the git commit has been done.

Example:

rm .x_aeon_agents/tmp/commits/commit_desc.txt

6. Push this commit on GitHub

• Always use cli: git push github to push the commit on GitHub.

Example:

git push github

Final Verification (MANDATORY)

Before declaring the task complete:

• Re-list all numbered steps from the committing-changes Execution Checklist.
• Confirm each one was executed.
• If any step was not executed, execute it now.

When to use it

• Always use it every time another skill specifically mentions skill: committing-changes.
• Always use it every time the user asks you to commit your changes.
• Always use it every time you need to commit your changes.

Usage and code examples

Those examples are given for a Linux environment. Adapt them if you are running in a Windows environment.

When project code, docs and tests were modified

If you modified lib/my_lib/my_class.rb, README.md and spec/scenarios/my_tests.rb files for the task, this skill should perform the following commands:

git add lib/my_lib/my_class.rb README.md spec/scenarios/my_tests.rb
# Use agent tool write_to_file to create file ./.x_aeon_agents/tmp/commits/commit_desc.txt
ruby {skill_path}/scripts/commit ./.x_aeon_agents/tmp/commits/commit_desc.txt
rm ./.x_aeon_agents/tmp/commits/commit_desc.txt
git push github