docs: updated the general guidelines section #1221
Conversation
YashPimple
requested review from
thisthat,
thschue,
bacherfl and
StackScribe
as code owners
github-actions
bot
added
the
documentation
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| ## Guidelines for contributing | ||
|
|
||
| * Always fork the repository then clone that fork to your local system | ||
| rather than clone `main` directly. |
There was a problem hiding this comment.
After the github contributing page is merged, this should like to the appropriate subsection of that page for directions.
| @@ -0,0 +1,35 @@ | |||
| ## Guidelines for contributing | |||
There was a problem hiding this comment.
Again, this file is in the wrong directory -- see comments in your PR for github. And that PR also includes the guidelines... So need to straighten this all out.
| Keptn, like most open source projects, | ||
| severely restricts who can push changes directly to the `main` branch | ||
| to protect the integrity of the repository. | ||
| * Keep your language clean and crisp. |
There was a problem hiding this comment.
This is a docs-only guideline. This list should be for both software and docs. For guidelines specific to either software or docs, I think I like putting those right after this list but we could instead put them in the software and docs sections. What do you think?
|
|
||
| If you see a problem and are unable to fix it yourself | ||
| or have an idea for an enhancement, | ||
| please create an issue on the GitHub repository: |
There was a problem hiding this comment.
| please create an issue on the GitHub repository: | |
| please create an issue on the GitHub repository. |
There was a problem hiding this comment.
Other than needing to move the source into the correct directory, this seems okay. What do you think when you read it? I'm thinking it could be better if you want to work on it. And, of course, we can always push it on through and update it later. We will want to come back to this to add links to other pages anyhow as we get more content in this guide.
So let's move the source to the right directory so it shows up where it should and then you decide how much more work you want to do before we put this out for review.
|
You are failing an annoying semantic test. If you make some small change to your branch and push it, the error will go away. |
|
Kudos, SonarCloud Quality Gate passed!
|
|
From another meeting, we have a request for a little sub-section here about naming PRs. Salient points are:
Review of this whole section should be a whole lot of fun! I'm sure there will be some conflicting opinions ;-) |
| * If you want to do the work on an issue, | ||
| include that information in your description of the issue | ||
| or in a comment to the issue. | ||
| ## [Guidelines for contributing](https://github.com/keptn/lifecycle-toolkit/tree/main/docs/content/en/docs/guidelines-for-contributing.md) |
There was a problem hiding this comment.
Please, don't use links in a header
|
Closed in favor of #1411 |
Related to #972
Fixes #995
Signed-off-by: Yash Pimple [email protected]