docs: updated the general guidelines section #1221
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -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. |
||||||
|
|
||||||
| * 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. |
||||||
| 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? |
||||||
| * Smaller PR's are easier to review and so generally get processed more quickly; | ||||||
| when possible, chunk your work into smallish PR's. | ||||||
| However, we recognize that documentation work sometimes requires larger PRs, | ||||||
| such as when writing a whole new section or reorganizing existing files. | ||||||
| * You may want to squash your commits before creating the final PR, | ||||||
| to avoid conflicting commits. | ||||||
| This is **not mandatory**; the maintainers will squash your commits | ||||||
| during the merge when necessary. | ||||||
| * Be sure that the description of the pull request itself | ||||||
| is meaningful and clear. | ||||||
| This helps reviewers understand each commit | ||||||
| and provides a good history after the PR is merged. | ||||||
| * If your PR is not reviewed in a timely fashion, | ||||||
| feel free to post a gentle reminder to the `#keptn-docs` Slack channel. | ||||||
| * Resolve review comments and suggestions promptly. | ||||||
|
|
||||||
| 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.
Suggested change
|
||||||
|
|
||||||
| * Provide specific and detailed information about the problem | ||||||
| and possible solutions to help others understand the issue. | ||||||
| * When reporting a bug, provide a detailed list of steps to reproduce the bug. | ||||||
| If possible, also attach screenshots that illustrate the bug. | ||||||
| * 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. | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Please, don't use links in a header