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

Update readmes to provide successful build instructions #2405

Merged

Conversation

chacebot
Copy link
Contributor

@chacebot chacebot commented Jul 24, 2024

  1. Updates CONTRIBUTING.md to use build script to test setup
  2. Adds link to CONTRIBUTING.md from base readme

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Each of my commits contains one meaningful change
  • I have performed rebase of my branch on top of the development
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have checked my code and corrected any misspellings

@zeibura
Copy link
Contributor

zeibura commented Jul 26, 2024

Please undo the readme update - for one thing the readme also displays on the VS Code Marketplace as well as on Github and the relative link to contributing.md won't do anything there. To contributors already at github reading contributing.md for such info is standard practice.

There is a lot of out of date stuff in that contributing.md file (all references to Che4z should be removed for a start and the contact email at the end is wrong). In the intro to the readme itself there is still a link to the obsolete Che4z repo which can be removed. If you undo the commit to the readme I can prepare a readme update on another branch (I can't make one to this branch as it's on your fork)

@chacebot
Copy link
Contributor Author

@zeibura Thank you for your input. Understood. The readme changes have been removed from this PR.

@zeibura
Copy link
Contributor

zeibura commented Jul 26, 2024

Thanks! Readme update is here: #2410

@Nurkambay Nurkambay merged commit 0a21b17 into eclipse-che4z:development Aug 8, 2024
4 of 5 checks passed
@chacebot chacebot deleted the fix-contribution-readme branch September 5, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants