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

Modify the README.md and add a COD.md #11

Open
Taity045 opened this issue Aug 4, 2020 · 8 comments
Open

Modify the README.md and add a COD.md #11

Taity045 opened this issue Aug 4, 2020 · 8 comments

Comments

@Taity045
Copy link

Taity045 commented Aug 4, 2020

#So i already created 2 pull requests i wasn't aware i should open an issue before doing that , @antoniolofiego pointed that out after i already did. Basically what i did was modify the READ.md and i noticed that there was no code of conduct , so jotted something real quick that can be modified at any point.

@antoniolofiego
Copy link
Collaborator

I am not sure if a Code of conduct is needed in the codebase. We already have one on the website as well as in the discord channel. If anything, Contribution Rules might be beneficial.

@Taity045
Copy link
Author

Taity045 commented Aug 4, 2020

sure let me work on it to fit for just contribution rules

@antoniolofiego
Copy link
Collaborator

https://github.com/excalidraw/excalidraw/blob/master/CONTRIBUTING.md

This can be an idea, to be adjusted for the Issue -> PR workflow that we adapted.

@what-name
Copy link
Collaborator

I don't think we need a CoC in this repo. We do need however contributing guidelines and rules. Not sure what yet tho, open to suggestions or maybe find a really solid one and translate it over to here?

@Taity045
Copy link
Author

Taity045 commented Aug 5, 2020

I do think contribution guidelines are important , what if someone wants to contribute and they're not part of the discord ?
I do understand you can create an issue first but , i figure it's better to have an overall idea before you go all the way into creating an issue , i don't know though maybe it's just me.

@what-name
Copy link
Collaborator

Yeah, that's what I meant too haha, sorry if it came out the opposite way. Contribution guidelines ARE important - Code of conduct is what's not (for this repo).

My couple ideas of what should the guidelines contain (not comprehensive)

  • A clear description of the what the PR and its changes entail
  • Why are these changes important
  • Make sure that you create tests where they are needed with the PyTest library. If you'd like to use another lanugage that is not python, please create an integration pipeline for it as well (see current one as example)
  • Make sure to reference an existing issue or create a new issue before submitting your PR if there is none.

@what-name
Copy link
Collaborator

See the Frontend's PR template, it's great: 100DaysOfCloud/100DaysOfCloudFrontend#28 (comment)

@Taity045
Copy link
Author

Taity045 commented Aug 5, 2020

Thanks , Chris this looks like a good start, closing the issue now

@Taity045 Taity045 closed this as completed Aug 5, 2020
@what-name what-name reopened this Aug 5, 2020
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

3 participants