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.

Sign up for GitHub

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

Jump to bottom

Add contributing guideline to the repo. #14

Merged
merged 1 commit into from
Sep 10, 2021
Merged

Add contributing guideline to the repo. #14

merged 1 commit into from
Sep 10, 2021

Conversation

Juke34
Copy link
Contributor

@Juke34 Juke34 commented Sep 1, 2021 •
edited
Loading

Add contributing guideline to the repo

@ropolomx ropolomx mentioned this pull request Sep 1, 2021
Open
@ropolomx
Copy link
Contributor

ropolomx commented Sep 1, 2021

Addresses #11.

greysaruman
greysaruman reviewed Sep 2, 2021
View reviewed changes
Copy link

@greysaruman greysaruman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Jacques, this guidelines document looks great! I think it would be perfect if we also include an example of a well-described issue in the "Did you find a bug?" section.

@Juke34 Juke34 requested review from Bdainat and ropolomx September 9, 2021 15:32
ropolomx
ropolomx reviewed Sep 10, 2021
View reviewed changes
Copy link
Contributor

@ropolomx ropolomx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The contributing guidelines look great! The only comment would be about adding an example to the "Did you find a bug?" section. This is excellent work and very helpful. It will be a work in progress, especially writing language accessible to non-technical users. I suggest that we add this now, and then we can refine or polish it more.

CONTRIBUTING.md
We thank you in advance :thumbsup: :tada: for taking the time to contribute, whether with *code* or with *ideas*, to the project.


## Did you find a bug?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As @greysaruman suggested, it would be great to have an example of a real bug in this section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added an issue template in #16.
I keept a standard one from github, feel free to suggest any update.

@Juke34
Copy link
Contributor Author

Juke34 commented Sep 10, 2021

This PR does not touch the code or the displayed content. So I go ahead with merging... it can be modified/improved at any time

@Juke34 Juke34 merged commit b12c709 into master Sep 10, 2021
@Juke34 Juke34 deleted the contributing branch September 10, 2021 07:53
@ropolomx
Copy link
Contributor

Thank you @Juke34 !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ropolomx ropolomx ropolomx left review comments

@greysaruman greysaruman greysaruman left review comments

@vrechdelaval vrechdelaval Awaiting requested review from vrechdelaval

@lilicamd lilicamd Awaiting requested review from lilicamd

@matveyryabov matveyryabov Awaiting requested review from matveyryabov

@Bdainat Bdainat Awaiting requested review from Bdainat

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Juke34 @ropolomx @greysaruman