Skip to content

Contributor's Guide #4

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

Closed
erogluorhan opened this issue Dec 18, 2020 · 14 comments
Closed

Contributor's Guide #4

erogluorhan opened this issue Dec 18, 2020 · 14 comments

Comments

@erogluorhan
Copy link
Member

Write a Contributor's Guide that defines collaboration methods for the Pythia Portal.

  • Either .md or .rst is fine
@kmpaul
Copy link
Collaborator

kmpaul commented Dec 21, 2020

I created a first draft of the CODE OF CONDUCT here:

CODEOFCONDUCT.md

@brian-rose
Copy link
Member

The first draft of the Contributor's Guide currently links to the Code of Conduct directly in the github repo. Probably better to make the CoC visible from the portal site itself.

@kmpaul
Copy link
Collaborator

kmpaul commented Dec 22, 2020

I just made some edits to the to site that:

  1. place the Contributor's Guide in the root directory of the repository,
  2. update the language of the CoC to be less UCAR specific,
  3. add custom scripting in conf.py to copy the CG and the CoC to the content/pages/ directory when the site is built,
  4. added a nav link to the CoC on the portal site.

I'm really sorry, but I forgot to clone my fork and cloned the main repo, instead. So, there was no PR to go with these changes, but you can see the site to see what was done.

@brian-rose
Copy link
Member

Just noting here that the CoC still says

The date that it was adopted by this project was [Enter date adopted].

I'm not sure if we need to have some explicit vote on adopting the CoC?

@kmpaul
Copy link
Collaborator

kmpaul commented Dec 23, 2020

I missed that. I'll fix it in another PR.

@kmpaul
Copy link
Collaborator

kmpaul commented Dec 23, 2020

...actually, I just added it to the open PR.

@kmpaul
Copy link
Collaborator

kmpaul commented Dec 23, 2020

Done and merged.

@kmpaul
Copy link
Collaborator

kmpaul commented Dec 23, 2020

However, I still think the Contributor's Guide needs more work. ...Should we close this issue for now and either re-open it when we want to improve the Contributor's Guide (or create another issue)?

@brian-rose
Copy link
Member

Hmm... I don't actually see any change in the CoC ??

@kmpaul
Copy link
Collaborator

kmpaul commented Dec 23, 2020

Yeah. Sorry. I forgot to push the change. 😄 I'm putting together another PR for some bugfixes.

@kmpaul kmpaul mentioned this issue Dec 23, 2020
@kmpaul
Copy link
Collaborator

kmpaul commented Dec 23, 2020

I believe this is fixed now.

@clyne
Copy link
Contributor

clyne commented Dec 29, 2020

However, I still think the Contributor's Guide needs more work. ...Should we close this issue for now and either re-open it when we want to improve the Contributor's Guide (or create another issue)?

I'd say either leave it open, or close and open a new ticket.

@erogluorhan
Copy link
Member Author

I am fine with closing this one, and we could open a new ticket when it comes to actually populating the Contributor's Guide

@brian-rose
Copy link
Member

Ok, I'll close this now, and open a new issue for discussion about the future of the Contributor's Guide.

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

No branches or pull requests

4 participants