diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..369a6185 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,91 @@ +name: Issue Reporting Template +description: >- + Use this template to report any issues. Provide as much detail as possible to + help us understand and resolve the issue effectively. +body: + - type: input + id: summary + attributes: + label: Summary + description: Provide a brief summary of the issue. + placeholder: 'Brief summary of the issue' + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: >- + Describe the issue in detail, including any relevant information or + steps to reproduce it. + placeholder: 'Detailed description of the issue' + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: Explain what you expected to happen. + placeholder: 'What you expected to happen' + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: Describe what actually happened. + placeholder: 'What actually happened' + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: >- + List the steps taken to reproduce the issue. Be as specific as possible, + including any relevant input or configuration details. + placeholder: 'Steps to reproduce the issue' + validations: + required: true + + - type: textarea + id: screenshots-logs + attributes: + label: Screenshots/Logs + description: >- + If applicable, attach any relevant screenshots or logs that may help + understand or troubleshoot the issue. + placeholder: 'Attach relevant screenshots or logs' + validations: + required: false + + - type: textarea + id: environment + attributes: + label: Environment + description: >- + Provide details about the environment in which the issue occurred. Include + information like Operating System, Browser, Device, etc. + placeholder: | + - Operating System: e.g., Windows 10, macOS Big Sur, Ubuntu 20.04 + - Browser: e.g., Chrome 93.0.4577.63, Firefox 92.0.1 + - Device: e.g., PC, laptop, smartphone + - Additional details: e.g., screen resolution, network connection type + validations: + required: true + + - type: textarea + id: additional-info + attributes: + label: Additional Information + description: >- + Provide any additional information that may be helpful in resolving the + issue, such as error messages, related links, or any troubleshooting + steps already attempted. + placeholder: 'Any additional information or suggestions' + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..07761beb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,97 @@ +name: Feature Request Template +description: >- + Use this template to submit a feature request. Provide detailed information + about the feature you would like to see implemented. For urgent issues or + questions, please contact us directly. +body: + - type: input + id: title + attributes: + label: Title + description: Give your feature request a descriptive title. + placeholder: 'Feature Title' + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: >- + Provide a detailed description of the feature you would like to see + implemented. Explain how it would enhance the product and benefit + the users. Feel free to include any specific use cases or scenarios. + placeholder: 'Describe the feature in detail' + validations: + required: true + + - type: textarea + id: potential-benefits + attributes: + label: Potential Benefits + description: >- + Describe the potential benefits or positive outcomes that implementing + this feature could bring. How would it improve user experience, + productivity, or any other aspect? + placeholder: 'Describe the benefits' + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: >- + If applicable, provide a specific use case or scenario where this feature + would be particularly useful. This can help us better understand the + practical application of the feature. + placeholder: 'Provide a specific use case' + validations: + required: false + + - type: textarea + id: additional-info + attributes: + label: Additional Information + description: >- + Include any additional information, ideas, or suggestions related to + your feature request. This could include references to similar features + in other products, related research, or any other relevant details. + placeholder: 'Any additional information or suggestions' + validations: + required: false + + - type: dropdown + id: priority + attributes: + label: Priority + description: Indicate the priority level for your feature request. + multiple: false + options: + - Low + - Medium + - High + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Impact + description: >- + Describe the potential impact of implementing this feature on your + workflow or the overall product experience. + placeholder: 'Describe the impact' + validations: + required: true + + - type: input + id: contact-info + attributes: + label: Contact Information + description: >- + If you would like to be contacted regarding your feature request, + please provide your preferred contact information (e.g., email address). + placeholder: 'Your contact information (optional)' + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/molecule_reporting_template.yml b/.github/ISSUE_TEMPLATE/molecule_reporting_template.yml new file mode 100644 index 00000000..e38e43f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/molecule_reporting_template.yml @@ -0,0 +1,65 @@ +name: Molecule Reporting Template +description: >- + Use this template to report synthetic compounds or request changes to an existing entry. + Please provide all required information to help us process your request efficiently. +body: + - type: dropdown + id: report-type + attributes: + label: Report Type + description: Select the type of report you want to make. + multiple: false + options: + - Synthetic compounds + - Request changes to an entry + validations: + required: true + + - type: input + id: coconut-id + attributes: + label: COCONUT ID + description: Please provide the COCONUT ID of the compound (e.g., CNP0000001). + placeholder: 'e.g., CNP0000001' + validations: + required: true + + - type: textarea + id: evidence + attributes: + label: Evidence + description: Provide evidence to support your report, such as experimental data, references, or other relevant documentation. + placeholder: 'Describe the evidence supporting your report' + validations: + required: true + + - type: textarea + id: citation-details + attributes: + label: Citation Details + description: Include citation details for any references used to support your report. + placeholder: 'Provide citation details (e.g., journal name, article title, authors, year)' + validations: + required: true + + - type: textarea + id: additional-info + attributes: + label: Additional Information + description: >- + Provide any additional information that may help us process your report, + such as relevant context, related compounds, or specific requests. + placeholder: 'Any additional information or context' + validations: + required: false + + - type: input + id: contact-details + attributes: + label: Contact Details (Optional) + description: >- + If you would like to be a curator for the reported compound, please provide your contact + details. We can add you to the database curators list. + placeholder: 'Your contact information (optional)' + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/natural_products_submission.yml b/.github/ISSUE_TEMPLATE/natural_products_submission.yml new file mode 100644 index 00000000..771afaa9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/natural_products_submission.yml @@ -0,0 +1,104 @@ +name: New Compound Submission Template +description: >- + Use this template to submit a new compound to the database. Please provide all required information for your submission to be processed. +body: + - type: input + id: compound-name + attributes: + label: Compound Name + description: Provide the name of the compound. + placeholder: 'Enter the compound name' + validations: + required: true + + - type: dropdown + id: structure-format + attributes: + label: Structure Format + description: Select whether you are providing a SMILES string or a Mol file. + options: + - SMILES string + - Mol file + validations: + required: true + + - type: textarea + id: smiles-or-molfile + attributes: + label: SMILES String or Mol File + description: >- + Provide the SMILES string or attach a Mol file representing the compound's structure. + placeholder: 'Enter SMILES string or paste Mol file content' + validations: + required: true + + - type: textarea + id: doi-citation + attributes: + label: DOI/Citation Information + description: >- + Include the DOI or full citation details for the source of the compound's information. + placeholder: 'Enter DOI or full citation details' + validations: + required: true + + - type: input + id: organism + attributes: + label: Organism + description: >- + Specify the organism from which the compound was derived (e.g., Mangifera indica). + placeholder: 'Enter organism name (e.g., Mangifera indica)' + validations: + required: true + + - type: input + id: geo-location + attributes: + label: Geographical Location (Optional) + description: >- + Provide the geographical location where the organism was found, including country and city (e.g., India/Bengaluru). + placeholder: 'Enter geographical location (e.g., India/Bengaluru)' + validations: + required: false + + - type: input + id: sample-location + attributes: + label: Sample Location (Organism Part) (Optional) + description: >- + Specify the part of the organism from which the sample was taken (e.g., Fruit). + placeholder: 'Enter sample location (e.g., Fruit)' + validations: + required: false + + - type: textarea + id: additional-comments + attributes: + label: Additional Comments + description: >- + Provide any additional comments or information that might be relevant to the submission. + placeholder: 'Enter any additional comments' + validations: + required: false + + - type: input + id: contact-details + attributes: + label: Contact Details (Optional) + description: >- + Provide your contact details if you would like to be contacted regarding this submission. + placeholder: 'Enter your contact information (optional)' + validations: + required: false + + - type: input + id: orcid-id + attributes: + label: ORCID ID + description: >- + Provide your ORCID ID for author identification (e.g., 0000-0002-2564-3243). + placeholder: 'Enter ORCID ID (e.g., 0000-0002-2564-3243)' + validations: + required: false +