-
Notifications
You must be signed in to change notification settings - Fork 152
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, GOVERNANCE.md, MAINTAINERS.md Docs #1287
Conversation
This will be re-added once we have decided on the support policy Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
LGTM |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍🏼
made. | ||
``` | ||
|
||
### Submitting Pull Requests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @ihcsim
is it a good idea to ask people to confirm with maintainers if the pull request that they are trying to raise would be a good addition. In some cases there are chances that the PR is raised but the maintainers don't think that the PR should get in.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Absolutely. Ideally, we would have prior discussion in GitHub issues/discussions, before pull requests are submitted. That's why in this section, I directed contributors to look up GitHub issues first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is okay to determine this on the PR itself. At least that's what I have seen on some other OSS repos
|
||
### Creating A Local Build | ||
|
||
See the [BUILD.md](BUILD.md) document for instructions on how to build, test and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are we yet to push the build.md?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It will be in a separate PR.
Change Overview
This PR adds the 1st iteration of the following docs to the repository:
Instructions on how to create and test a local build will be added to BUILD.md in a separate PR.
Pull request type
Please check the type of change your PR introduces:
Issues
Fix #1119
Fix #1234