Better Comments Bitbucket is an extension designed to enhance the clarity and effectiveness of comments in Bitbucket code reviews by using Conventional Comments. The tool provides shortcuts for each type of comment and an explanation of their meanings.
- Comment Shortcuts: Quick access to 'question', 'thought', 'issue', and more.
- Integrated Explanations: Each comment type comes with a clarification of its correct usage.
- Open the Chrome Web Store.
- Search for "Better Comments Bitbucket".
- Click "Add to Chrome".
- Confirm the installation.
- Once installed, open Bitbucket and navigate to a code review.
- Use the shortcuts provided by the extension to insert conventional comments.
- Refer to the integrated explanations to ensure correct usage of each comment type.
If you encounter any issues or bugs, please report them so we can fix them. Follow these steps to report a bug:
- Go to the Issues section in our GitHub repository.
- Click on "New Issue".
- Select the "Bug Report" template.
- Fill in the required information, providing as many details as possible:
- Description of the issue
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Screenshots (if possible)
- Click "Submit new issue".
Contributions are welcome! If you would like to contribute to Better Comments Bitbucket, follow these steps:
- Fork the repository: Better Comments Bitbucket.
- Create a branch for your feature or fix:
git checkout -b feature/new-feature
orgit checkout -b fix/bug-fix
. - Make your changes and commit them:
git commit -m 'Add new feature'
. - Push your changes to your fork:
git push origin feature/new-feature
orgit push origin fix/bug-fix
. - Open a Pull Request in the original repository.
- Complete the Pull Request template, clearly describing the changes made and their purpose.
Please ensure your code follows our coding style guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
For any questions or suggestions, feel free to contact us through the GitHub repository.
Thank you for using Better Comments Bitbucket! 🎉
Developed by Brian