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

Added development.md #900

Conversation

nlewis05
Copy link
Collaborator

closes #853

Added development.md

@scholarsmate scholarsmate added the documentation Improvements or additions to documentation label Nov 27, 2023
@scholarsmate scholarsmate added this to the 1.4.0 milestone Nov 27, 2023
@nlewis05 nlewis05 marked this pull request as ready for review November 29, 2023 18:36
@nlewis05 nlewis05 self-assigned this Nov 30, 2023
Copy link
Contributor

@scholarsmate scholarsmate left a comment

Choose a reason for hiding this comment

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

+1.

You'll have to create this as a single patch and rebase on the current main before it will be mergable.

DEVELOPMENT.md Outdated Show resolved Hide resolved
Copy link
Contributor

@shanedell shanedell left a comment

Choose a reason for hiding this comment

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

+1. Just rebase off of the Apache repo's main branch and squash all commits except one. Then create a message you like and force push up to your branch.

@nlewis05 nlewis05 force-pushed the Split-the-README.md-into-README.md-and-DEVELOPMENT.md branch from 4c1a395 to 9237482 Compare December 6, 2023 16:49
@nlewis05 nlewis05 force-pushed the Split-the-README.md-into-README.md-and-DEVELOPMENT.md branch from 3335938 to c985a88 Compare December 6, 2023 17:11
@shanedell shanedell merged commit 7a328fd into apache:main Dec 6, 2023
21 checks passed
@shanedell shanedell deleted the Split-the-README.md-into-README.md-and-DEVELOPMENT.md branch December 6, 2023 18:03
@stevedlawrence
Copy link
Member

I just noticed this PR contains links to assets in github.com/ctc-oss, should those assets be moved to daffodil-vscode so everything is in this repo?

@nlewis05
Copy link
Collaborator Author

nlewis05 commented Dec 6, 2023

Ah I see what you mean, I was curious how that worked with the PR and if it would move them over here, but I guess that's not how that works, I'll see about moving them over here

@nlewis05
Copy link
Collaborator Author

nlewis05 commented Dec 6, 2023

Seems they may have to be added manually by someone with write access to that wiki file @shanedell

@stevedlawrence
Copy link
Member

Another option is to replace images with text where possible. For example, the image that shows the fork button could be replaced with the a link to https://github.com/apache/daffodil-vscode/fork. Making things a user can copy paste or click is probably a bit easier than telling people to find a button on another page. Avoiding images where possible is also friendlier to people with visual impairments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Split the README.md into README.md and DEVELOPMENT.md
5 participants