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 developer documentation #752

Merged
merged 2 commits into from
Nov 26, 2019
Merged

Update developer documentation #752

merged 2 commits into from
Nov 26, 2019

Conversation

micahellison
Copy link
Member

@micahellison micahellison commented Nov 19, 2019

I wanted to get the ball rolling on updating the contributing docs as per #693. Contributions and suggestions welcome!

  • Adding table of contents because it's a little long (plus, some folks just want to jump straight to environment setup details at the end)
  • Cleaning up markdown for readability/maintainability (we like those hashes over the hyphens, right?)
  • Updating issue links to point to issue template selections instead of generic new issues
  • Adding in development notes (I'd like some help here, especially with really clear yet platform-agnostic language)

Checklist

  • [n/a] The code change is tested and works locally.
  • [n/a] Tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • [n/a] Have you written new tests for your core changes, as applicable?

@micahellison micahellison added documentation Improvements or additions to documentation help wanted More help wanted from a contributor labels Nov 19, 2019
Copy link
Member

@wren wren left a comment

Choose a reason for hiding this comment

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

🍰

@wren wren changed the base branch from master to develop November 26, 2019 04:24
@wren wren merged commit 223277a into jrnl-org:develop Nov 26, 2019
@micahellison micahellison changed the title [GH-693] Updating developer documentation (work in progress) Update developer documentation Jan 11, 2020
@lock
Copy link

lock bot commented May 21, 2020

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot added the 🔒 Outdated label May 21, 2020
@lock lock bot locked as resolved and limited conversation to collaborators May 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation help wanted More help wanted from a contributor 🔒 Outdated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants