Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adds contributing guide and issue templates #68

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

sufyankhanrao
Copy link
Collaborator

What

This PR adds CONTRIBUTING.md guides and issue templates such as bug-report.yml and feature-request.yml.

Why

This will help the users in contributing to this library effectively

Type of change

Select multiple if applicable.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause a breaking change)
  • Tests (adds or updates tests)
  • Documentation (adds or updates documentation)
  • Refactor (style improvements, performance improvements, code refactoring)
  • Revert (reverts a commit)
  • CI/Build (adds or updates a script, change in external dependencies)

Dependency Change

If a new dependency is being added, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Policy-of-adding-new-dependencies-in-the-core-libraries

Breaking change

If the PR is introducing a breaking change, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Guidelines-for-maintaining-core-libraries

Testing

List the steps that were taken to test the changes

Checklist

  • My code follows the coding conventions
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added new unit tests

This commit adds CONTRIBUTING.md guides and issue templates such as bug-report.yml and feature-request.yml.
@sufyankhanrao sufyankhanrao added the documentation Improvements or additions to documentation label Feb 7, 2025
@sufyankhanrao sufyankhanrao self-assigned this Feb 7, 2025
Copy link

sonarqubecloud bot commented Feb 7, 2025

@haseeb-mhr haseeb-mhr self-requested a review February 12, 2025 13:33
@sufyankhanrao sufyankhanrao removed the request for review from asadali214 February 12, 2025 13:34
@sufyankhanrao sufyankhanrao merged commit d8d2797 into main Feb 12, 2025
7 checks passed
@sufyankhanrao sufyankhanrao deleted the contribution-guide-and-issue-template branch February 12, 2025 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants