Skip to content

Commit ca9cc29

Browse files
manisha841manisha841
committed
fix: merge conflicts
2 parents 11cfe97 + 6e4746f commit ca9cc29

File tree

11 files changed

+807
-232
lines changed

11 files changed

+807
-232
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yaml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: Bug Report
2+
description: Report a bug
3+
labels: ["bug", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Before you start
9+
> Please **make sure you are on the latest version.**
10+
Please fill out the sections below to help everyone identify and fix the bug
11+
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: Describe the issue
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduce
22+
attributes:
23+
label: Steps to reproduce
24+
description:
25+
Please provide a detailed account of the steps necessary to reproduce the issue.
26+
The more specific you are, the better chance we have of identifying and resolving the bug.
27+
Kindly list your tasks and/or queries in text format instead of using screenshots.
28+
29+
placeholder: |
30+
Here's an example of the level of detail required to reliably and efficiently reproduce any bugs.
31+
1. Go to the '...' page.
32+
2. Click on the '...' button.
33+
3. Scroll down to '...'.
34+
4. Observe the error.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: expected
40+
attributes:
41+
label: Describe what you expected to happen.
42+
placeholder: I expected this to happen
43+
44+
- type: textarea
45+
id: screenshots
46+
attributes:
47+
label: Put here any screenshots or videos (optional)
48+
49+
- type: textarea
50+
id: environment
51+
attributes:
52+
label: Environment
53+
description: |
54+
Provide details about your operating system, software/tool version, and any additional relevant information about your environment.
55+
placeholder: |
56+
Operating System: [Specify your operating system and version, e.g., Windows 10, macOS 11.2.3, Ubuntu 20.04.]
57+
Software/Tool Version: [Specify the version of the software or tool you're using, if applicable.]
58+
Additional Information: [Include any other relevant information about your environment.]
59+
60+
- type: dropdown
61+
id: assign
62+
attributes:
63+
label: "Would you like to work on this issue?"
64+
options:
65+
- "Yes"
66+
67+
- type: checkboxes
68+
id: acknowledgements
69+
attributes:
70+
label: 'Acknowledgements'
71+
description: 'Please confirm the following:'
72+
options:
73+
- label: 'My issue title is concise, descriptive.'
74+
required: true
75+
- label: "I searched the existing issues to ensure this bug hasn't been reported."
76+
required: true
77+
- label: 'I am using the latest version of repo.'
78+
required: true
79+
- label: 'I have provided enough information for the maintainers to reproduce and diagnose the issue.'
80+
required: true
81+
82+
- type: markdown
83+
attributes:
84+
value: |
85+
Thanks for reporting this issue! We will get back to you as soon as possible.

‎.github/ISSUE_TEMPLATE/custom-issue.yaml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Custom Issue
2+
description: Create a custom issue
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
## Before you start
8+
> Please **make sure you are on the latest version.**
9+
Please fill out the sections below to describe your issue or request.
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Summary
15+
description: Provide a brief summary of your issue or request.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Description
23+
description: Provide detailed information about your issue or request.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: proposed_solution
29+
attributes:
30+
label: Proposed Solution (if applicable)
31+
description: Describe your proposed solution or idea, if applicable.
32+
33+
- type: textarea
34+
id: screenshots
35+
attributes:
36+
label: Screenshots (optional)
37+
description: |
38+
Include screenshots or other visuals to help illustrate your issue or request, if applicable.
39+
40+
- type: markdown
41+
attributes:
42+
value: |
43+
Thank you for providing your issue or request! We will review it and get back to you as soon as possible.

‎.github/ISSUE_TEMPLATE/feature-request.yaml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature Request / Enhancement
2+
description: Suggest a new feature or feature enhancement for the project
3+
labels: ["enhancement", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
⚠️ Please fill out all required sections for your feature request and ensure it has not been suggested before in the discussion or issue tab.
9+
10+
- type: textarea
11+
id: feature-description
12+
validations:
13+
required: true
14+
attributes:
15+
label: 🔖 Feature description
16+
description: A clear and concise description of what the feature request is.
17+
placeholder: You should add ...
18+
19+
- type: textarea
20+
id: rationale
21+
attributes:
22+
label: Describe alternatives you've considered
23+
placeholder: A clear and concise description of any alternative solutions or features you've considered
24+
25+
- type: textarea
26+
id: context
27+
attributes:
28+
label: Additional context
29+
placeholder: |
30+
Add any other context or screenshots about the feature request here.
31+
32+
- type: checkboxes
33+
id: acknowledgements
34+
attributes:
35+
label: Acknowledgements
36+
description: 'Please confirm the following:'
37+
options:
38+
- label: My issue title is clear and descriptive.
39+
required: true
40+
- label: I have checked existing issues to ensure this feature is not requested yet.
41+
required: true
42+
- label: I have provided sufficient details for maintainers to understand and assess this request.
43+
required: true
44+
45+
- type: dropdown
46+
id: assign
47+
attributes:
48+
label: Would you like to work on this issue?
49+
options:
50+
- "Yes"
51+
52+
- type: markdown
53+
attributes:
54+
value: |
55+
Thank you for your suggestion! Let's work together to see if we can implement it.

‎.github/pull_request_template.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Summary
2+
3+
> Please summarize your changes in the title above in a general way.
4+
5+
## Pull request type
6+
7+
> Please try to limit your pull request to one type, and submit multiple pull requests if needed.
8+
9+
Please tick the type of change your PR introduces:
10+
11+
- [ ] Bugfix
12+
- [ ] Feature
13+
- [ ] Code style update (formatting, renaming)
14+
- [ ] Refactoring (no functional changes, no API changes)
15+
- [ ] Build related changes
16+
- [ ] Documentation content changes
17+
- [ ] Other (please describe):
18+
19+
## What is the current behaviour?
20+
21+
> Please describe the behaviour that needs to be modified or linked to a relevant issue.
22+
23+
Issue Number: N/A
24+
25+
## What is the current behaviour?
26+
27+
> Please describe the changes or updates being made by this pull request.
28+
29+
-
30+
-
31+
-
32+
33+
## Checklist
34+
35+
Please review and complete the following checklist before submitting your pull request:
36+
37+
- [ ] I have tested the changes locally and they work as intended.
38+
- [ ] I have provided a detailed description of the changes made.
39+
- [ ] I have reviewed the formatting and ensured it follows the project's style guidelines.
40+
- [ ] I have assigned the appropriate labels to the pull request.
41+
- [ ] I have added necessary documentation or updated existing documentation for the changes made.
42+
- [ ] I have addressed code review feedback and resolved any conflicts with the main branch.
43+
44+
## Other information
45+
46+
> Include screenshots of the component before and after the change.

‎CONTRIBUTION.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
## Contributing Guidelines
2+
<hr>
23

34
Thank you for considering contributing to our project! We welcome contributions from everyone. To maintain a positive and collaborative environment, please follow these guidelines:
45

56
### Creating Issues:
7+
<hr>
68

79
1. **Search Existing Issues**: Before creating a new issue, please search existing issues to see if the topic has already been discussed or reported.
810

@@ -12,7 +14,23 @@ Thank you for considering contributing to our project! We welcome contributions
1214

1315
4. **Use Labels**: Use appropriate labels to categorize your issue (e.g., bug, enhancement, documentation, etc.).
1416

17+
### Development Setup:
18+
<hr>
19+
20+
1. Fork and clone the Repository
21+
2. Pull latest changes from the main repository if it has diverged
22+
3. [Create a virtual environment for the project](https://docs.python.org/3/library/venv.html)
23+
4. Install dependencies using `pip install -r requirements.txt`
24+
5. Install pre-commit hook using `pre-commit install`
25+
6. Run tests using `pytest tests/test_file_name.py ` or specific test name like `pytest tests/test_file_name.py::test_function_name`
26+
7. Do not push changes without the tests and coverage passing
27+
8. Commit your changes with **proper** commit messages in imperative form like `Add my best feature`, `Fix issues casusing whatever`, `Update docs` etc: [Good reference here](https://cbea.ms/git-commit/)
28+
9. Make changes and push to your forked repository
29+
10. Create PR to the forked repository as mentioned below
30+
31+
1532
### Pull Requests (PRs):
33+
<hr>
1634

1735
1. **Fork the Repository**: Start by forking the repository to your GitHub account.
1836

0 commit comments

Comments
 (0)