legumeinfo / website-ui-specs

User interface specification of components built for the Jekyll sites.
Apache License 2.0
0 stars 0 forks source link

Small change to gene-search UI #20

Open jd-campbell opened 4 weeks ago

jd-campbell commented 4 weeks ago

I would like to request a feature to the gene-search UI and I know that Alan has specific way that spec changes need to be done. Before I do anything I wanted to ask if I am on the right track on how this is supposed to be done. Below is how I was thinking about submitting a feature request. Please tell me if I am correct or not.

Steps:

  1. Make a branch within the website-ui-spec
  2. Make changes to README.md in gene-search 2.1. Change version number from 1.2.0 to 1.3.0 2.2. Change details under Input list 2.3. Create and upload new input mockup image
  3. Submit PR for Alan to review.

Is this right?

adf-ncgr commented 4 weeks ago

sounds fine to me but I guess @alancleary is the main arbiter of process here so will defer to him

alancleary commented 4 weeks ago

I don't recall being in charge of the process; I was just advocating for having a spec finalized and versioned before anything was implemented. That said, I like the process you outlined, @jd-campbell. I could make that a checklist in an issue template in the repo if people think that's a good idea.

adf-ncgr commented 4 weeks ago

+1 to issue templates

jd-campbell commented 4 weeks ago

@alancleary Can I make the issue template -- I want to practice.

adf-ncgr commented 4 weeks ago

@jd-campbell go for it!

alancleary commented 4 weeks ago

@alancleary Can I make the issue template -- I want to practice.

Just be sure to add it to the repo via a PR :wink:

adf-ncgr commented 4 weeks ago

Just be sure to add it to the repo via a PR 😉

says the guy who recently disavowed being in charge of process... 🙊

jd-campbell commented 4 weeks ago

@alancleary --- I cannot make an issue template because I need to be a repo owner to access repo settings https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

so I have to give this task back you. Sorry.

alancleary commented 4 weeks ago

Hmm. That's not how I've created issue templates in other repos; I've always just create a .github/ISSUE_TEMPLATE/template-name.md file in the repo. Here's an example in the graphql-server repo: https://github.com/legumeinfo/graphql-server/blob/main/.github/ISSUE_TEMPLATE/release-checklist.md

jd-campbell commented 4 weeks ago

Thanks this is a great example. I will state working on this now and send a PR to you.