Merge pull request #37 from GoogleCloudPlatform/feature/b-324783050/a…

…dd-contribution-rules

Feature/b 324783050/add contribution rules

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Let us know what went wrong.
+---
+
+# Description
+
+Describe you situation in details (i.e. with the logs, screenshots, etc). \
+**Remember, it's better to add something extra than to miss something
+important.**
+
+# Expected Behavior
+
+Describe the behavior you are expecting.
+
+# Current Behavior
+
+What is the current behavior?
+
+# Steps to Reproduce
+
+Provide detailed steps for reproducing the issue.
+
+1. Step 1
+2. Step 2
+3. ...
+
+# Context
+
+Provide any relevant info about your environment.
+
+* Tool Version:
+* Operating System:
+* Shell *(i.e. bash v4, zsh, etc.)*

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,33 @@
+---
+name: Feature request
+about: Let us know how we can make things better.
+---
+
+# Description
+
+Provide a detailed description of the feature you are requesting (e.g. text,
+charts, diagrams, etc.) \
+**Remember, it's better to add something extra than to miss something
+important.**
+
+# Use Case
+
+Describe a specific scenario or use case where this feature would be beneficial. \
+Explain why this feature is important for users or the project as a whole.
+
+# Proposed Implementation
+
+If you have any ideas or suggestions for how the feature could be implemented,
+please outline them here. \
+Include any technical details or considerations that may be relevant.
+
+# Potential Impact
+
+Discuss the potential impact of implementing this feature as you see it. \
+Consider factors such as user experience, performance, scalability, etc. \
+Also, mention any potential risks or drawbacks associated with the feature.
+
+# Additional Information
+
+Include any additional information, resources, or references that may be
+relevant to the feature request.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+## Description
+
+Describe your request in details.
+
+**Remember, it's better to add something extra than to miss something important.**
+
+## Checklist
+
+> [!TIP]
+> *Remember, there is an option to create a **Draft Pull Request** if you are not ready for merging.*
+
+Check compliance with the following [task list](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) and describe any forced non-compliances:
+
+- [ ] [Consistency standards](https://github.com/GoogleCloudPlatform/gce-rescue/blob/main/CONTRIBUTING.md#consistency-standards) have been met
+- [ ] New code complies with the [PEP8](https://peps.python.org/pep-0008/)
+- [ ] All Python tests passed after the changes
+- [ ] New changes have been tested on all supported platforms
+
+## Notes
+
+Any additional comments to make life easier for the reviewers?

CONTRIBUTING.md

@@ -26,4 +26,59 @@ information on using pull requests.
 ## Community Guidelines
 
 This project follows
-[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
+[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
+
+## Consistency standards
+
+> *Strive for simplicity while keeping a balance between code readability and
+efficiency.*
+
+### Commit message
+
+We aim to adopt the Conventional Commits specification to improve readability,
+clarity, and collaboration.
+
+https://www.conventionalcommits.org/en/v1.0.0/#specification
+
+### Branch name
+
+Similar to commit naming, there are various methods to name branches. Let's
+adhere to these simple template in our project:
+
+```
+<category/reference/description-in-kebab-case>
+```
+
+- **`category`** distinguishes the types of activities in the branches. Options
+are:
+ - `feature` - adding a new feature or refactoring existing code
+ - `bugfix` - fixing an issue/bug (i.e. unplanned changes)
+ - `test` - experimenting, PoC, etc.
+
+- **`reference`** points to the source of info about the purpose of this branch.
+Current options are:
+ - `issue-123` - GitHub issue number
+ - `b-1234567` - Buganizer ID *(for now, only for Googlers)*
+ - `no-ref` - when there is no reference *(e.g. for `test` branches)*
+
+- **`description-in-kebab-case`** of the problem. Try to keep a balance between
+ brevity and informativeness.
+
+### Issue / Pull request content
+
+Several useful templates for new issues and pull requests will be provided
+automatically. Although not mandatory, adhering to them helps standardize the
+review process.
+
+All Pull Requests, with rare exceptions *(such as docs, minor wording edits,
+etc.), should use the `develop` branch as a base. Only team members have
+permissions to push to the `main` branch.
+
+### Code style
+
+We strive to adhere the standard [PEP8](https://peps.python.org/pep-0008/)
+document for our code. Utilize tools like
+[`pycodestyle`](https://pypi.org/project/pycodestyle/) *(formerly `pep8`)* or
+[`black`](https://pypi.org/project/black/) for syntax compliance checks.
+Additionally, consider [`pylint`](https://pypi.org/project/pylint/) with the
+standard configuration for more comprehensive syntax analysis.