Skip to content

[Junie]: docs: update README with project guidelines and instructions#4

Merged
yuuues merged 2 commits intomasterfrom
jetbrains-junie/issue-3-run-dd33c15d-8bcd-488a-a7bf-c13ceae3cda5
Jul 15, 2025
Merged

[Junie]: docs: update README with project guidelines and instructions#4
yuuues merged 2 commits intomasterfrom
jetbrains-junie/issue-3-run-dd33c15d-8bcd-488a-a7bf-c13ceae3cda5

Conversation

@jetbrains-junie
Copy link
Copy Markdown
Contributor

📌 Hey! This PR was made for you with Junie, the coding agent by JetBrains Early Access Preview

It's still learning, developing, and might make mistakes. Please make sure you review the changes before you accept them.
We’d love your feedback — join our Discord to share bugs, ideas: here.

📊 Junie Summary

The project guidelines have been successfully updated in the README.md file, including sections on Contributing Guidelines, Testing Standards, and Git Commit Guidelines. This addition enhances the project's documentation by providing detailed instructions for contributors on coding standards, testing practices, and commit message formats. No errors occurred during this update.

 The project guidelines have been successfully updated in the README.md file, including sections on Contributing Guidelines, Testing Standards, and Git Commit Guidelines. This addition enhances the project's documentation by providing detailed instructions for contributors on coding standards, testing practices, and commit message formats. No errors occurred during this update.
@yuuues
Copy link
Copy Markdown
Owner

yuuues commented Jun 19, 2025

i want to update the .junie/guidelines.md file, not the README
@jetbrains-junie

@yuuues
Copy link
Copy Markdown
Owner

yuuues commented Jun 19, 2025

@jetbrains-junie junie i want to update the .junie/guidelines.md file, not the README

@jetbrains-junie
Copy link
Copy Markdown
Contributor Author

Hey, it’s Junie by JetBrains! I started processing your request 🚀

The project guidelines have been successfully moved from the README.md file to the newly created `.junie/guidelines.md` file, ensuring proper documentation organization. The README.md file has been updated accordingly to remove the guidelines content, with no errors encountered during the process.
@jetbrains-junie
Copy link
Copy Markdown
Contributor Author

The project guidelines have been successfully moved from the README.md file to the newly created .junie/guidelines.md file, ensuring proper documentation organization. The README.md file has been updated accordingly to remove the guidelines content, with no errors encountered during the process.

@yuuues
Copy link
Copy Markdown
Owner

yuuues commented Jun 19, 2025

@jetbrains-junie Please record in .junie/guidelines.md any relevant details that will aid future development on this project. This should include, but is not limited to:

Build/Configuration Instructions: If specific build or configuration steps are required, provide clear and detailed instructions for setting up the project.

Testing Information:

Instructions for configuring and running tests.
Guidelines on adding and executing new tests.
Create and run a simple test to demonstrate the process.
Additional Development Information: Information about the code style or any other information you believe would be useful for the development or debugging process.

Important Notes:

This information is intended for an advanced developer; there's no need to include basic things, only information specific to this project.
Сheck that the test examples work before writing the information to the file.
At the end delete all additional files that you created except .junie/guidelines.md

@jetbrains-junie
Copy link
Copy Markdown
Contributor Author

Hey, it’s Junie by JetBrains! I started processing your request 🚀

@yuuues yuuues merged commit fa04fb1 into master Jul 15, 2025
1 check failed
@yuuues yuuues deleted the jetbrains-junie/issue-3-run-dd33c15d-8bcd-488a-a7bf-c13ceae3cda5 branch July 15, 2025 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant