mstryoda / gommons Goto Github PK

Hi,
Adding Issue templates is effective for a more efficient issue opening process. Adding an Issue Form can provide a more effective and controlled process with required fields. It can be useful in blocking content that is empty or does not provide enough information.

It will also ensure that those who contribute to this repository for the first time understand exactly what is expected, IMO.

See Official GitHub Documentation for more information.

Contribution guidelines are important for developers who want to contribute to the repository.
A guide with information such as guidelines for contributors to follow, don'ts and conditions to follow will be effective and helpful.

Adding an open source license to the project is important to protect the rights of the project and its contributors.

Please add an open source license to the repository specifying the terms and conditions for how the project should be used, modified and distributed.

Please add documentation comments for public functions and definitions.

This is for the benefit of developers using it. It will also enable a developer who wants to make changes in the relevant region better grasp or remember the situation. Therefore, it is recommended to document it in the source code.

Please see documentation(s) for Go's documentation comments.

• Go Doc Comments
• Godoc: documenting Go code

Adding CI workflows is important for maintaining the project.

This makes it easy for contributors to identify that their changes caused any test failures, also makes it easier for maintainers and PR owner to notice for PRs opened by missing tests.

Hi,
One or more of the packages may contain very serious security vulnerabilities. I think that a security policy should be added that includes information such as reporting vulnerabilities, the patch process and how to take action when detected.

For example, here is Jule's Securiy Policy.

As the repository grows, documenting it in the README will become crowded and difficult to read.

To prevent this, it would be healthier to document in each package or in a separate documentation directory specifically for each package. This is a good approach to organize and maintain documentations.