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

Update contributing guide #167

Open
peterdesmet opened this issue Oct 7, 2017 · 3 comments
Open

Update contributing guide #167

peterdesmet opened this issue Oct 7, 2017 · 3 comments
Assignees
Milestone

Comments

@peterdesmet
Copy link
Member

@peterdesmet peterdesmet commented Oct 7, 2017

Contributing guide should include:

  • What is part of the standard and what is not (an implementation of SDS)
  • What the rules are for updating the standard (an implementation of VMS)
  • How one can submit an issue
  • For the adventurous: how one can update the term_versions.csv vocabulary as a pull request: add new line, update previous term

And we should include an ISSUE_TEMPLATE.md. As we can only have one, I think a term change or new term is probably the most used one...

@tucotuco
Copy link
Member

@tucotuco tucotuco commented Sep 5, 2020

The document currently resides at https://github.com/tdwg/dwc/blob/master/.github/CONTRIBUTING.md. Would it be better at https://github.com/tdwg/dwc?

I agree that there should be a reference to the VMS, but is this really the place to say what is normative in the standard?

I would recommend against adding anything about amending term_versions.csv.

I set up two issue templates, one for new term requests and one for term change requests.

If I can get consensus I'll proceed to make the changes.

@tucotuco tucotuco self-assigned this Sep 5, 2020
@tucotuco
Copy link
Member

@tucotuco tucotuco commented Sep 5, 2020

Partial changes made to match issue templates in 551c64e

@baskaufs
Copy link
Contributor

@baskaufs baskaufs commented Sep 5, 2020

With respect to the usage comments, we might indicate that they are optional and only necessary if the definition does not provide all of the needed information about how the term should be used. I don't know how to say that in a way that is not too wordy and suitable for a form.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.