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

Open-source checklist #3

Open
11 tasks
lutangar opened this issue Apr 8, 2021 · 1 comment
Open
11 tasks

Open-source checklist #3

lutangar opened this issue Apr 8, 2021 · 1 comment
Assignees

Comments

@lutangar
Copy link
Member

lutangar commented Apr 8, 2021

How you write (and code) affects your brand, too!
Throughout the life of your project, you’ll do a lot of writing: READMEs, tutorials, community documents, responding to issues, maybe even newsletters and mailing lists.

Whether it’s official documentation or a casual email, your writing style is part of your project’s brand. Consider how you might come across to your audience and whether that is the tone you wish to convey.
https://opensource.guide/starting-a-project/#how-you-write-and-code-affects-your-brand-too

Overall

Idea: Create co-authored commit on the code of conduct and other important files to show everyone read and particpated in the contrusction of the document.
https://docs.github.com/en/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-the-command-line

  • Implement exemple labels to add to new project:

  • [] Documentation websites

    • Each repositories could have its own documentation website

https://docsify.js.org/#/quickstart
https://docusaurus.io/

Extension

  • README

  • Issues

    • The issue queue is up-to-date, with issues clearly organized and labeled
  • Sentry up & running & useful

Backend

  • Pre-commit hook for CS
  • Check for strict typings
  • Sentry up & running & useful

Mobile

  • Sentry up & running & useful

Website

  • Sentry up & running & useful
@lutangar lutangar self-assigned this Apr 8, 2021
@lutangar lutangar changed the title Checklist Open-source checklist Apr 8, 2021
@lutangar
Copy link
Member Author

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

No branches or pull requests

1 participant