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

Issue tracker module #109

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

DrewBrasher
Copy link

For Issue #101

@hishamco
Copy link
Member

Do you need any help on this?

@DrewBrasher
Copy link
Author

@hishamco I've started outlining some definitions and things the project needs to have in the readme.md file. Feel free to add or change anything or let me know and I can add/change it.

I do have a couple of questions.

  1. Should I add Models, Drivers, Handlers, Views, ViewModels, and Settings for every content part or are some of these usually only added if needed?
    image

  2. Since Projects and Issues need a lot of the same information, What do you think would be the best way to design that? Would we have a part that has all of that information and then add that part to both Issue and Project content types?

@hishamco
Copy link
Member

hishamco commented Feb 2, 2024

Should I add Models, Drivers, Handlers, Views, ViewModels, and Settings for every content part or are some of these usually only added if needed?

It depends

Since Projects and Issues need a lot of the same information

I think we should create a content type for each. Please list to me the shared information.

@DrewBrasher
Copy link
Author

I think we should create a content type for each. Please list to me the shared information.

Common to both an Issue and a Project

  • Title
  • Body (html or markdown)
  • Requestor contact information
  • Members (Assign to one or more users who are responsible for the task)
  • Attach files
  • Category
  • Different groups of people should be linked to different categories. For example, IT would be responsible for the category "Computer" and Application Development would be responsible for the "Website" category
  • Status (New, In Progress, completed, cancelled, etc)
  • Priority
  • Comments
  • Milestones

https://github.com/DrewBrasher/OrchardCoreContrib.Modules/tree/IssueTrackerModule/src/OrchardCoreContrib.IssueTracker#common-to-both-an-issue-and-a-project

@hishamco
Copy link
Member

While there's no notion of content type inheritance using fields and parts might suited in this case even though there are several common properties

@DrewBrasher
Copy link
Author

It thought about having a Part that has Fields for all the stuff both Issues and Projects need and then adding that Part to the Issue and Project content types.

@hishamco
Copy link
Member

I usually add a part if it's fit to be reusable across content types and could add certain functionality, for now, let's make it simple

Please add a check list for this module so we can make progress, and avoid conflict

@DrewBrasher
Copy link
Author

I have a checklist in the readme file or is there some other checklist I should create?

@hishamco
Copy link
Member

Please add them again in the issue description, so we can keep track of this module

@DrewBrasher
Copy link
Author

Please add them again in the issue description, so we can keep track of this module

I've added the checklist to the issue description.

@DrewBrasher
Copy link
Author

I usually add a part if it's fit to be reusable across content types and could add certain functionality, for now, let's make it simple

Should I deleted all the IssuePart files highlighted in #109 (comment) and just create content types for Issue and Project in the migration file without creating Parts for them?

@hishamco
Copy link
Member

hishamco commented Apr 4, 2024

It depends, I usually use content type unless there's a set of fields that are reusable in multiple content types. IMHO let's accelerate the process and make progress in this, then we can revise and improve the module

Please let me know if you need help at any stage

@DrewBrasher
Copy link
Author

I've never created a module with content types in the code before. I've only created a theme module and for the content types I created them in the UI and then exported the recipe and added that to my theme. So I'm learning how to do this as I go.

@DrewBrasher
Copy link
Author

I just found https://github.com/Lombiq/Helpful-Extensions?tab=readme-ov-file#content-definition-code-generation and I think I will try using that method to create the content types.

@hishamco
Copy link
Member

hishamco commented Apr 5, 2024

I've never created a module with content types in the code before

You can create a content type programmatically through migration, I will share piece of code If you like to know how it's done

@hishamco
Copy link
Member

Do you need any help on this?

@DrewBrasher
Copy link
Author

Do you need any help on this?

Will you take a look at commit 21762e9 and let me know if I'm on the right track?

@hishamco
Copy link
Member

hishamco commented Apr 28, 2024

Please fix a conflict and have a look at my comments I might need to add a few commits

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.

2 participants