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

Create README.md #422

Merged
merged 2 commits into from
May 26, 2019
Merged

Create README.md #422

merged 2 commits into from
May 26, 2019

Conversation

ephbaum
Copy link
Contributor

@ephbaum ephbaum commented May 24, 2019

When reading announcement it referenced the README file for reporting issues but there isn't a root README... and the ISSUE_TEMPLATE.md wasn't referenced by the README files within the sub-folders... and generally it felt like there should be a README

... every project should have an up front README file. (This is one.)

When reading [announcement](https://www.dxx-rebirth.com/news/dxx-rebirth-rebooted/) it referenced the README file for reporting issues but there isn't a root README...  and the ISSUE_TEMPLATE.md wasn't referenced by the README files within the sub-folders... and generally it felt like there should be a README

... every project should have an up front README file.  (This is one.)
@vLKp
Copy link
Contributor

vLKp commented May 25, 2019

ISSUE_TEMPLATE.md doesn't need to be referenced by the README, because it is primarily for the benefit of the Github Issue Tracker to pre-fill the issue text. This project's README files migrated down into subdirectories when the source repositories were unified.

  • The forum link changed after the README files you used as a reference.
  • Github's markdown parser seems to want to do the wrong thing with the inline * in one of the lists.

Thanks for reminding me that this needs to be done. I'll clean up the minor points above and get this merged.

@vLKp vLKp self-assigned this May 25, 2019
@ephbaum
Copy link
Contributor Author

ephbaum commented May 26, 2019

Happy to get the ball rolling.

For what it's worth, the ISSUE_TEMPLATE.md is old style so an update to the template structure might be worth looking into as well: https://help.github.com/en/articles/about-issue-and-pull-request-templates

- Update forum links
- Tweak new Issue Reporting section text
- Escape asterisk
vLKp added a commit that referenced this pull request May 26, 2019
@vLKp
Copy link
Contributor

vLKp commented May 26, 2019

Thank you for the link. I wasn't aware that the format used here was deprecated, nor that Github had a proposed successor. I've split the template accordingly.

@vLKp vLKp merged commit a8f7fca into dxx-rebirth:master May 26, 2019
vLKp added a commit that referenced this pull request May 26, 2019
@ephbaum ephbaum deleted the add-readme branch May 26, 2019 23:00
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.

None yet

2 participants