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.

Sign up for GitHub

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

Jump to bottom

Project Management / Open Source Prep #44

Open
3 of 11 tasks
adam-resdiary opened this issue Oct 5, 2020 · 0 comments
Open
3 of 11 tasks

Project Management / Open Source Prep #44

adam-resdiary opened this issue Oct 5, 2020 · 0 comments
Labels
type/epic Used to describe a larger chunk of work that will need to be broken down into further tasks
Milestone
Initial Stable Re...

Comments

@adam-resdiary
Copy link
Collaborator

adam-resdiary commented Oct 5, 2020 •
edited by adamconnelly
Loading

This is a placeholder task to track any tasks that need to be performed before the project is ready for public adoption, but that aren't related to functionality that the project provides.

  • Setup CI/CD pipelines.
    • Build and run tests against PRs.
    • Publish nuget packages.
    • Create GitHub releases.
  • Create a contribution guide.
  • Figure out if we need to get contributors to sign a Contributor License Agreement.
  • Create a strategy for using GitHub labels.
  • Create issue templates to make reporting problems / requesting new functionality easier.
  • Make sure we have enough documentation.
    • Getting started guides.
    • Documentation about specific configuration / functionality (enabling/disabling linting rules, etc).
    • Guides for contributors (e.g. how to work on the compiler, how to make changes to the library, project structure, testing, etc).
  • Automatically update dependencies using Dependabot, Renovate or something similar.
  • Come up with a strategy for security disclosures.
@adam-resdiary adam-resdiary added the type/epic Used to describe a larger chunk of work that will need to be broken down into further tasks label Oct 5, 2020
adamconnelly added a commit that referenced this issue Oct 7, 2020
@adamconnelly
docs: add contribution guide
5489407 
- Moved the contribution information from the README into a separate CONTRIBUTING.md file.
- Tweaked the design goals and roadmap to remove unnecessary information, and update them to remove
  references to `I want`.

Part of #44
adamconnelly added a commit that referenced this issue Oct 9, 2020
@adamconnelly
chore(docs): move docs to their own folder
24203f0 
- Moved all of the docs, except for the README and LICENSE to their own folder so that the root of
  the repo doesn't end up cluttered.
- Added a link in the README to the Thrift website.
- Fixed a problem where Prettier had removed the `#` from `C#` in a header. I've ended up using the
  HTML code instead to stop markdownlint complaining about having a `#` symbol in a header, and
  added a temporary ignore to stop it complaining about the trailing `;`.

Part of #44
adamconnelly added a commit that referenced this issue Oct 9, 2020
@adamconnelly
chore(docs): added info about labels
64b95b8 
- Added an overview of the labelling scheme to the contribution guide.
- Removed all the full stops from the end of the TOC items since they seemed unnecessary.

Part of #44
adamconnelly added a commit that referenced this issue Oct 9, 2020
@adamconnelly
chore(docs): fixing a few mistakes in the docs
637c429 
- I'd accidentally written "apache" rather than "MIT" license.
- I missed updating a few links when I moved the docs to their own folder.

Part of #44
adamconnelly added a commit that referenced this issue Oct 9, 2020
@adamconnelly
chore(docs): fix broken link to Antlr project file
6e28a46 
Part of #44
@adamconnelly adamconnelly added this to the Initial Stable Release milestone Nov 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type/epic Used to describe a larger chunk of work that will need to be broken down into further tasks
Projects
None yet
Milestone
Initial Stable Release
Development

No branches or pull requests
2 participants
@adamconnelly @adam-resdiary