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

Contributing docs and issue/PR templates #98

Merged
merged 5 commits into from
Nov 21, 2023
Merged

Conversation

Pandelissym
Copy link
Contributor

Added a CONTRIBUTING.md page with information on how to raise issues for bug reports or feature requests and steps on how to create a PR.

Added templates for:

  • Creating an issue for reporting bugs
  • Creating an issue for requesting a feature
  • Creating a PR

The issue templates are made using github forms (https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms) and are hence written in yaml.

The PR template is written in markdown as github forms are not supported for PR templates yet.

Fixes #91

@Pandelissym Pandelissym self-assigned this Nov 17, 2023
@Pandelissym Pandelissym marked this pull request as draft November 17, 2023 09:42
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
@Pandelissym Pandelissym marked this pull request as ready for review November 17, 2023 13:28
Copy link
Contributor

@carlos-kryha carlos-kryha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@Pandelissym Pandelissym merged commit f5b0fa5 into develop Nov 21, 2023
3 checks passed
@Pandelissym Pandelissym deleted the docs/contributing branch November 21, 2023 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

As a developer i want to be able to contribute to the KREAd project and be instructed on how to do so
2 participants