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

add CONTRIBUTING.md #57

Closed
wants to merge 0 commits into from
Closed

add CONTRIBUTING.md #57

wants to merge 0 commits into from

Conversation

altafan
Copy link
Collaborator

@altafan altafan commented Jul 22, 2019

Closes #56

@altafan altafan requested review from lorenzodisidoro and tiero July 22, 2019 20:36
@tiero
Copy link
Member

tiero commented Jul 23, 2019

I would add more information on the process of review, master-read only, mandatory review and one test suite.

@lorenzodisidoro
Copy link

We could split the file in more paragraphs, something like this:

  • Contributing (modus operandi for opening PRs) where we explain contributing workflow
  • Rules eg. explain opened PR into the comment, linking the related issues, squashing, ...
  • Categories define the boundaries of main PR categories because cannot be mixed (eg. bug fixing, new feature, refactoring, ...)

Copy link
Member

@tiero tiero left a comment

Choose a reason for hiding this comment

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

+1

CONTRIBUTING.md Outdated

Hereafter is detailed how to proceed in order to contribute to Nigiri.

## Rules
Copy link
Member

Choose a reason for hiding this comment

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

make bold on the keywords (master branch, Pull requests etc..)

CONTRIBUTING.md Outdated
@@ -0,0 +1,35 @@
# Contributing
Copy link
Member

Choose a reason for hiding this comment

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

Link this in the readme.md

@tiero
Copy link
Member

tiero commented Jul 26, 2019

I would keep in hold, meanwhile we find a solution for import paths

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

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md
3 participants