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, GOVERNANCE.md, MAINTAINERS.md Docs #1287

Merged
merged 6 commits into from
Mar 30, 2022
Merged

Conversation

ihcsim
Copy link
Contributor

@ihcsim ihcsim commented Mar 16, 2022

Change Overview

This PR adds the 1st iteration of the following docs to the repository:

  • CONTRIBUTING.md
  • GOVERNANCE.md
  • MAINTAINERS.md
  • CODEOWNER

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:

  • 🚧 Work in Progress
  • 🌈 Refactoring (no functional changes, no api changes)
  • 🐹 Trivial/Minor
  • 🐛 Bugfix
  • 🌻 Feature
  • 🗺️ Documentation
  • 🤖 Test

Issues

Fix #1119
Fix #1234

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>
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
MAINTAINERS.md Outdated Show resolved Hide resolved
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
@viveksinghggits
Copy link
Contributor

LGTM

Copy link
Contributor

@pavannd1 pavannd1 left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏼

CONTRIBUTING.md Show resolved Hide resolved
made.
```

### Submitting Pull Requests
Copy link
Contributor

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.

Copy link
Contributor Author

@ihcsim ihcsim Mar 22, 2022

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.

Copy link
Contributor

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
Copy link
Contributor

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?

Copy link
Contributor Author

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.

@shuguet shuguet added this to Reviewer approved in Kanister Mar 23, 2022
@ihcsim ihcsim added the kueue label Mar 30, 2022
@mergify mergify bot merged commit 5922089 into master Mar 30, 2022
Kanister automation moved this from Reviewer approved to Done Mar 30, 2022
@mergify mergify bot deleted the docs branch March 30, 2022 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging this pull request may close these issues.

Add Governance to the Kanister project CONTRIBUTING guide is missing
3 participants