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.

Sign up for GitHub

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

Jump to bottom

CONTRIBUTING.md #5042

Merged
merged 7 commits into from
Sep 13, 2024
Merged

CONTRIBUTING.md #5042

merged 7 commits into from
Sep 13, 2024

Conversation

tiloKo
Copy link
Member

@tiloKo tiloKo commented Sep 10, 2024 •
edited
Loading

  • create new CONTRIBUTING.md in root folder
  • delete old one in .github subfolder
  • adopted links (README.md, docs)
  • moved development related content from old CONTRIBUTING.md (mainly for groovy development) to DEVELOPMENT.md
  • moved DEVELOPMENT.md into the documentation subfolder

@tiloKo tiloKo requested a review from a team as a code owner September 10, 2024 13:46
o-liver
o-liver requested changes Sep 11, 2024
View reviewed changes
Copy link
Member

@o-liver o-liver left a comment

Choose a reason for hiding this comment

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

Great, thanks for that! Let's add the https://github.com/SAP/.github/blob/main/CONTRIBUTING_USING_GENAI.md document as well and fix the reference link.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CCFenner
CCFenner reviewed Sep 11, 2024
View reviewed changes
CONTRIBUTING.md
Copy link
Member

Choose a reason for hiding this comment

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

What is the reason of moving this? If you don't mind, please leave it in .github folder to declutter the root directory. I would rather move the DEVELOPMENT.md file there as well.

Copy link
Member

Choose a reason for hiding this comment

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

Also one cannot really see what has changed.

Copy link
Member Author

@tiloKo tiloKo Sep 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

  • Obviously the OSPO did not find the file
  • A folder starting with a dot is in some environments considered hidden
  • Contribution is some key element of an os project, so imho it is important enough to put in in the root directory
  • I would agree to move the DEVELOPMENT.md in the documentation folder
  • I do not see any relation or dependency between github and contribution which is implied if the file is put in a subdirectory of this name.

https://mozillascience.github.io/working-open-workshop/contributing/
"CONTRIBUTING.md should be in your root directory"

@tiloKo tiloKo requested a review from o-liver September 12, 2024 07:05
o-liver
o-liver reviewed Sep 12, 2024
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
tiloKo
tiloKo commented Sep 12, 2024
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
o-liver
o-liver approved these changes Sep 13, 2024
View reviewed changes
Copy link
Member

@o-liver o-liver left a comment

Choose a reason for hiding this comment

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

Looks good to me. @CCFenner Is it ok with you?

@o-liver
Copy link
Member

o-liver commented Sep 13, 2024

/it

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@tiloKo
Copy link
Member Author

tiloKo commented Sep 13, 2024 •
edited
Loading

I did all the changes once more but for moving the file I used git mv command.

  • On commit level you see now the diff
  • but on PR level github still shows it as deleted/new file (in the files changed section).
  • anyway if you display the file as is you have the history of the file displayed

@tiloKo
Copy link
Member Author

tiloKo commented Sep 13, 2024

/it

@tiloKo tiloKo merged commit dbeb462 into SAP:master Sep 13, 2024
13 of 14 checks passed
maxatsap added a commit to maxatsap/jenkins-library that referenced this pull request Oct 1, 2024
@maxatsap
Merge remote-tracking branch 'origin/master' into malwarescan-async-scan
802634c 
* origin/master: (35 commits)
  feat(notification): Notify in case of Release failure (SAP#5045)
  fix(docs): remove dead links (SAP#5051)
  chore: remove obsolete cloud sdk conversion file (SAP#5036)
  feat: fail if script is not found in package.json file (SAP#5029)
  feat(sonar): Enable trustengine for token retrieval (SAP#5046)
  feat(trustengine): Add new resource reference to parameter docs generation (SAP#5038)
  docs: add unit test tags flag (SAP#4947)
  CONTRIBUTING.md (SAP#5042)
  addon.yml may now contain wildCard MAXX (SAP#5039)
  fix(codeqlExecuteScan): handle spaces in path to maven settings file (SAP#5037)
  feat(trustengine): Integrate Trust Engine into step config resolver (SAP#5032)
  fix(http): Use configured logger for retryClient (SAP#5040)
  Updated helm.sh/helm from 13.14.0 to 13.14.2 (SAP#5041)
  Copy full project (SAP#5033)
  feat(vault): support complex data types in secrets (SAP#5006)
  Added pagination logic for retrieving projects from Black Duck server (SAP#5031)
  Update aws deps (SAP#5034)
  Add possible values and default (SAP#5030)
  Fix security issues reported by Black Duck (SAP#5014)
  Exposing build artifact metadata from maven and npm  (SAP#5008)
  ...
maxatsap added a commit to maxatsap/jenkins-library that referenced this pull request Oct 1, 2024
@maxatsap
Merge remote-tracking branch 'origin/master' into whitesource-sbt-con…
5c5c7e6 
…fig-fix

* origin/master: (35 commits)
  feat(notification): Notify in case of Release failure (SAP#5045)
  fix(docs): remove dead links (SAP#5051)
  chore: remove obsolete cloud sdk conversion file (SAP#5036)
  feat: fail if script is not found in package.json file (SAP#5029)
  feat(sonar): Enable trustengine for token retrieval (SAP#5046)
  feat(trustengine): Add new resource reference to parameter docs generation (SAP#5038)
  docs: add unit test tags flag (SAP#4947)
  CONTRIBUTING.md (SAP#5042)
  addon.yml may now contain wildCard MAXX (SAP#5039)
  fix(codeqlExecuteScan): handle spaces in path to maven settings file (SAP#5037)
  feat(trustengine): Integrate Trust Engine into step config resolver (SAP#5032)
  fix(http): Use configured logger for retryClient (SAP#5040)
  Updated helm.sh/helm from 13.14.0 to 13.14.2 (SAP#5041)
  Copy full project (SAP#5033)
  feat(vault): support complex data types in secrets (SAP#5006)
  Added pagination logic for retrieving projects from Black Duck server (SAP#5031)
  Update aws deps (SAP#5034)
  Add possible values and default (SAP#5030)
  Fix security issues reported by Black Duck (SAP#5014)
  Exposing build artifact metadata from maven and npm  (SAP#5008)
  ...
maxatsap added a commit to maxatsap/jenkins-library that referenced this pull request Oct 1, 2024
@maxatsap
Merge remote-tracking branch 'origin/master' into kaniko-context-pref…
486eb9c 
…ix-fix

* origin/master: (35 commits)
  feat(notification): Notify in case of Release failure (SAP#5045)
  fix(docs): remove dead links (SAP#5051)
  chore: remove obsolete cloud sdk conversion file (SAP#5036)
  feat: fail if script is not found in package.json file (SAP#5029)
  feat(sonar): Enable trustengine for token retrieval (SAP#5046)
  feat(trustengine): Add new resource reference to parameter docs generation (SAP#5038)
  docs: add unit test tags flag (SAP#4947)
  CONTRIBUTING.md (SAP#5042)
  addon.yml may now contain wildCard MAXX (SAP#5039)
  fix(codeqlExecuteScan): handle spaces in path to maven settings file (SAP#5037)
  feat(trustengine): Integrate Trust Engine into step config resolver (SAP#5032)
  fix(http): Use configured logger for retryClient (SAP#5040)
  Updated helm.sh/helm from 13.14.0 to 13.14.2 (SAP#5041)
  Copy full project (SAP#5033)
  feat(vault): support complex data types in secrets (SAP#5006)
  Added pagination logic for retrieving projects from Black Duck server (SAP#5031)
  Update aws deps (SAP#5034)
  Add possible values and default (SAP#5030)
  Fix security issues reported by Black Duck (SAP#5014)
  Exposing build artifact metadata from maven and npm  (SAP#5008)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CCFenner CCFenner CCFenner left review comments

@o-liver o-liver o-liver approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tiloKo @o-liver @CCFenner