Markdown docs per discord channel, working group and topic files
please create a subdirectory per topic channel
the README.md for each topic should be pinned and put into the channel description in the discord
either in the README.md or in a link to EXISTING.md, we would like to have a maintained list of existing solutions in each topic in a fixed format. The current template is
name (of existing solution): [keybase, pgp, oauth etc]
underlying tech: [blockchain, keypairs, etc]
used-by: [fediverse, ssb, twitter, etc]
approx num users: [+/- order of magnitude]
how-to-use: [can it be used by other stacks/platforms? how?]
reasons: [for use/not use]
requests: [what would be good to do next with this method]
Users may also upload other docs for discussion, as PRs are a nice place to make inline comments.
please create a subdirectory for each working group
The README.md for each working group should contain :
Lead:
Contact methods: (if not only discord)
Description of group:
Next goals - either link to [Taiga](http://taiga.whatscookin.us/project/bluesky-community/kanban) task/epics or include in the markdown, a list of
Deliverable:
ETA:
Assignee:
Stale goals may be removed, and stale working groups may be archived.
Please upload other documents that are needed to support the goals. If you find gitlab too cumbersome leave some breadcrumbs in the readme to your preferred method.
This area does not require repo pages, as each app/protocol generally has its own external home page that can be put in the channel description.
What type of role or category do you fall into? This will help you take an action that is helpful to you and everyone:
User Story:
- I want to pitch my project/protocol to the BlueSky community
- Submit yourself to the next(s) panel discussion.
- Submit a CodeLab/other tutorial
- I am an intern looking to help teams that align with my values
- Look at this list of project summaries and try their tutorial
- Try another, or join!
- Look at this list of project summaries and try their tutorial
- I do not have time, I no longer have ego attached to projects, I’m an expert to help consult and give war stories
- Personal backchannels with them and connecting teams.
- I want to hear nuanced discussions around important design decisions/ features related to decentralized social networks.
- Submit your topic/ potential panelists for the next panel discussion.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!
- Create or upload files
- Add files using the command line or push an existing Git repository with the following command:
cd existing_repo
git remote add origin https://gitlab.com/bluesky-community/flow.git
git branch -M main
git push -uf origin main
- Invite team members and collaborators
- Create a new merge request
- Automatically close issues from merge requests
- Automatically merge when pipeline succeeds
Use the built-in continuous integration in GitLab.
- Get started with GitLab CI/CD
- Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to makeareadme.com for this template.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Choose a self-explaining name for your project.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.