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

Move and expand contributing.md content into docs site #1180

Closed
micahellison opened this issue Feb 6, 2021 · 1 comment · Fixed by #1266
Closed

Move and expand contributing.md content into docs site #1180

micahellison opened this issue Feb 6, 2021 · 1 comment · Fixed by #1266
Assignees
Labels
documentation Improvements or additions to documentation 📌 This can't go stale
Milestone

Comments

@micahellison
Copy link
Member

Documentation Change

There is a lot going in our contributing.md file and we're thinking of adding more. Moreover, we have several different audiences for this file (docs writers, testers, and developers), and we might be able to reach more of them through the jrnl.sh site.

It seems like it would be a good move to create a new section in the documentation for contributors, with subsections for each of these audiences.

As part of this, the developer documentation could be expanded to include some information on the project's architecture and our process for pinning and resolving GitHub issues.

After this work is done, the contributing.md shouldn't be removed, but it should mainly just link to this new documentation.

@micahellison micahellison added documentation Improvements or additions to documentation 🆕 New! labels Feb 6, 2021
@micahellison micahellison removed the 🆕 New! label Feb 13, 2021
@micahellison micahellison added this to the Backlog milestone Apr 20, 2021
@stale
Copy link

stale bot commented Jun 19, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Inactive issue: will be closed soon if no activity label Jun 19, 2021
@micahellison micahellison added 📌 This can't go stale and removed stale Inactive issue: will be closed soon if no activity labels Jun 19, 2021
@micahellison micahellison self-assigned this Jun 19, 2021
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 📌 This can't go stale
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant