Skip to content

Commit

Permalink
fix: changed templates (#80)
Browse files Browse the repository at this point in the history
  • Loading branch information
WolodjaZ authored Sep 18, 2024
1 parent ad1452b commit 615896f
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 86 deletions.
5 changes: 2 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Contributing

## Request for changes/ Pull Requests

You first need to create a fork of the [meteors](https://github.com/xai4space/meteors) repository to commit your changes to it. When you have made your changes, you can open a pull request on the [meteors repository](https://github.com/xai4space/meteors/pulls).
Hi My friend! Thank you for considering contributing to Meteors!
Please follow the guidelines in [contribution guide here](https://xai4space.github.io/meteors/latest/how-to-guides/) to ensure a smooth and efficient contribution process.
68 changes: 39 additions & 29 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,56 @@
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
title: "bug: <Please write a comprehensive title after the 'bug: ' prefix>"
title: "fix: <Please write a comprehensive title after the 'fix: ' prefix>"
body:
- type: textarea
id: description
- type: markdown
attributes:
label: "Description"
description: Please enter an explicit description of your issue
placeholder: Short and explicit description of your incident...
validations:
required: true
value: >
Thank you for taking the time to report an issue. Please fill the form below.
- type: checkboxes
id: checks
attributes:
label: Checklist
description: Please confirm and check all the following options.
options:
- label: I added a very descriptive title to this issue.
required: true
- label: I used the GitHub search to find a similar question and didn't find it.
required: true
- label: I am sure that this is a bug in Meteors rather than my code.
required: true
- label: The bug is not resolved by updating to the latest stable version of Meteors.
required: true
- label: I included a link to the documentation page I am referring to (if applicable).
required: true
- type: textarea
id: reprod
id: reproduction_steps
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
render: bash
placeholder: |
The following code:
```python
from meteors.foo import foo
def bad_code(inputs) -> int:
raise NotImplementedError('For demo purpose')
chain = foo(bad_code)
chain.invoke('Hello!')
```
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
id: error
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
label: Error Message and Stack Trace (if applicable)
description: |
If you are reporting an error, please include the full error message and stack trace.
placeholder: |
Exception + full stack trace
- type: dropdown
id: os
attributes:
Expand Down
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ body:
options:
- label: I added a very descriptive title to this issue.
required: true
- label: I used the GitHub search to find a similar question and didn't find it.
required: true
- label: The bug is not resolved by updating to the latest stable version of Meteors.
required: true
- label: I included a link to the documentation page I am referring to (if applicable).
required: true
- type: textarea
Expand Down
57 changes: 15 additions & 42 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,60 +1,33 @@
name: "💡 Feature Request"
description: Create a new ticket for a new feature request
title: "feat: <Please write a comprehensive title after the 'feature: ' prefix>"
description: Create a new ticket for a feature request
title: "feat: <Please provide a clear and concise title>"
body:
- type: input
id: start_date
attributes:
label: "Start Date"
description: Start of development
placeholder: "month/day/year"
validations:
required: false
- type: textarea
id: implementation_pr
id: description
attributes:
label: "Implementation PR"
description: Pull request used
placeholder: "#Pull Request ID"
validations:
required: false
- type: textarea
id: reference_issues
attributes:
label: "Reference Issues"
description: Common issues
placeholder: "#Issues IDs"
validations:
required: false
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief explanation of the feature
placeholder: Describe in a few lines your feature request
label: "Feature Description"
description: Provide a clear and concise description of the feature you're requesting.
validations:
required: true
- type: textarea
id: basic_example
id: use_case
attributes:
label: "Basic Example"
description: Indicate here some basic examples of your feature.
placeholder: A few specific words about your feature request.
label: "Use Case"
description: Describe the use case or problem this feature would solve.
validations:
required: true
- type: textarea
id: drawbacks
id: reference_issues
attributes:
label: "Drawbacks"
description: What are the drawbacks/impacts of your feature request ?
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
label: "Reference Issues"
description: If there are any related issues, reference them here (e.g., "Closes #123", "Relates to #456").
placeholder: "#Issues IDs"
validations:
required: false
- type: textarea
id: unresolved_question
id: additional_context
attributes:
label: "Unresolved questions"
description: What questions still remain unresolved ?
placeholder: Identify any unresolved issues.
label: "Additional Context"
description: Add any other context, examples, or references that would help clarify the feature request.
validations:
required: false
19 changes: 7 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Contributing to Meteors

Thank you for contributing to meteors! Please follow the guidelines below to ensure a smooth and efficient contribution process.
Thank you for contributing to Meteors! Please follow the guidelines below to ensure a smooth and efficient contribution process.

## PR Checklist

- [ ] **PR Title**: `"semantic tag: description"`

- **Package**: Use the appropriate semantic tag for your PR:
- `feat`: A new feature.
- `fix`: A bug fix.
- `feat`: A new feature.
- `docs`: Documentation only changes.
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
- `refactor`: A code change that neither fixes a bug nor adds a feature.
Expand All @@ -18,24 +18,19 @@ Thank you for contributing to meteors! Please follow the guidelines below to ens
- `build`: Changes that affect the build system or external dependencies.
- **Example**: `"fix: typo in README.md"`

- [ ] **Related Issue(s)**: If your PR fixes an issue, please link it in the PR description.

- [ ] **PR Message**: **_Delete this entire checklist_** and replace it with:

- **Description**: A detailed description of the change.
- **Dependencies**: Any dependencies required for this change.

- [ ] **Add Tests and Docs**: If adding a new features, please include:

1. A test for the feature, preferably unit tests that do not rely on network access.
2. An example notebook showing its use, located in the `examples` directory.
- [ ] **Add tests and docs**: If you're adding a new integration, please include

- [ ] **Lint**: Ensure your code passes linting and all tests:
1. a test for the integration, preferably unit tests that do not rely on network access,
2. an example notebook showing its use, located in the `examples` directory.

- Code is formatted with `pre-commit` hooks. Run `pre-commit install` and `pre-commit run --all-files` to format your code.
- [ ] **Lint and test**: Run `rye run pre-commit run --all-files` and `rye test` to ensure your changes pass all checks. See [contribution guidelines](https://xai4space.github.io/meteors/latest/how-to-guides/) for more.

- [ ] **Tests**: Ensure all tests pass:
- Run `pytest` in the root directory to run all tests.
- [ ] **Related Issue(s)**: If your PR fixes an issue, please link it in the PR description.

## Additional Guidelines

Expand Down

0 comments on commit 615896f

Please sign in to comment.