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 CONTRIBUTING.md #41

Merged
merged 2 commits into from
Aug 13, 2022
Merged

Update CONTRIBUTING.md #41

merged 2 commits into from
Aug 13, 2022

Conversation

merks
Copy link
Contributor

@merks merks commented Aug 13, 2022

Add a badge-styled link to the CDT configuration and simplify the setup description.

I've added the badge-styled link to the configuration.  I've commented out the section with detailed steps because the configuration automates all those steps and because the page opened by the link also has all these instructions.

The description on that page has a description specific to CDT.

It comes from here:

https://github.com/eclipse-cdt/cdt/blob/455f7fc25a2567587d6091bf615741a484822db4/releng/CDTConfiguration.setup#L37-L49

Best to use the properties view to edit this content so that the XML is properly escaped.
@merks
Copy link
Contributor Author

merks commented Aug 13, 2022

@jonahgraham @ruspl-afed

I've added the badge-styled link to the configuration. I've commented out the section with detailed steps because the configuration automates all those steps and because the page opened by the link also has all these instructions.

The description on that page has a description specific to CDT.

image

It comes from here:

<description>
&lt;p>
The &lt;a href=&quot;https://www.eclipse.org/cdt/&quot;/>Eclipse C/C++ Development Tools&lt;/a> configuration provisions a dedicated development environment
for the complete set of source projects of the &lt;a href=&quot;https://projects.eclipse.org/projects/tools.cdt&quot;>CDT project&lt;/a>.
&lt;/p>
&lt;p>
All the source projects from &lt;a href=&quot;https://github.com/eclipse-cdt&quot;>CDT's Github Repositories&lt;/a>
are available, organized into working sets, and ready for contribution.
&lt;/p>
&lt;/p>
Please &lt;a href=&quot;https://wiki.eclipse.org/Eclipse_Platform_SDK_Provisioning&quot;>read the analogous tutorial instructions&lt;/a> for the Eclipse Platform SDK's configuration for more details.
&lt;/p>
</description>

Best to use the properties view to edit this content so that the XML is properly escaped.

image

You can preview what it looks like in the hover:

image

@ruspl-afed ruspl-afed requested a review from jonahgraham August 13, 2022 09:56
Copy link
Member

@jonahgraham jonahgraham left a comment

Choose a reason for hiding this comment

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

LGTM - I also deleted the commented out stuff.

@jonahgraham jonahgraham merged commit 9695d54 into eclipse-cdt:main Aug 13, 2022
@jonahgraham
Copy link
Member

Thanks @merks

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.

2 participants