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

Feature/open source template #42

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @nikolamajcen @ZvonimirMedak
Copy link
Member

Choose a reason for hiding this comment

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

Honestly, I'm totally fine that you set only yourself here as a maintainer. I could be added manually any time you need me 👍

43 changes: 0 additions & 43 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Bug report
description: File a bug report.
labels: bug
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: |
An environment information where issue occurred. Try to provide as much information as possible, including:
- device name, model and manufacturer
- operating system version
- software name, version and build number
- additional information (e.g. dependencies, IDE, etc.)
value: |
- Device:
- Operating system:
- Software information:
- Additional information:
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Reproduction steps
description: Steps to reproduce the behavior.
value: |
1.
2.
3.
...
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: additional-information
attributes:
label: Additional information
description: Any additional information that might be helpful in solving the issue.
validations:
required: false

19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Feature request
description: Propose a new feature or an idea for Sentinel.
labels: enhancement
body:
- type: textarea
id: feature-description
attributes:
label: Feature description
description: A clear and concise description of the feature request, including what problem it solves.
validations:
required: true
- type: textarea
id: additional-information
attributes:
label: Additional information
description: An additional information or screenshots about the feature request.
validations:
required: false
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

<!--
Provide an overview of what this pull request aims to address or achieve.

Link any relevant issues that this pull request addresses or resolves, using the format "Fixes #issue_number".
-->

**Related issue**: <!-- Add the issue number in format [#<number>](link) or set to "None" if this is not related to a reported issue. -->

## Changes

### Type
Expand Down Expand Up @@ -39,4 +39,4 @@

<!--
Add any additional comments, instructions, or insights about this pull request.
-->
-->
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,17 @@ Welcome to our project! We appreciate your interest in helping us improve it.

There are multiple ways in which you can help us make this project even better.

- Reporting bugs or suggesting new features
- Contributing code improvements or new features
- Writing, updating, or fixing tests
- Improving documentation, including inline comments, user manuals, and developer guides

## Issue reporting

If you found a bug or have an idea for a new feature, please open an issue. Be sure to include a clear and descriptive title, as well as a detailed description of the bug or feature.

To avoid duplicate issues, please check if a similar issue has already been created.

## Making changes

To make changes to the project, please follow these steps:
Expand All @@ -28,11 +35,14 @@ Once we check everything, we will merge the changes into the main branch and inc

When submitting a pull request, please ensure that:

- Your pull request is concise and well-scoped
- Your code is properly tested
- Your code adheres to the project's coding standards and style guidelines
- Your commit message is clear and descriptive
- Your pull request includes a description of the changes you have made and why you have made them

Try to avoid creating large pull requests that include multiple unrelated changes. Instead, break them down into smaller, more focused pull requests. This will make it easier for us to review and merge your changes.

## Code of conduct

We want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [code of conduct](/CODE_OF_CONDUCT.md).
Expand Down
Loading