Giter VIP home page Giter VIP logo

.github's People

Contributors

allcontributors[bot] avatar ifycode avatar

Stargazers

 avatar

Watchers

 avatar  avatar

.github's Issues

Use AGPL 3.0 License or not?

Suggested improvement
Identify all active Code Collabo repos that could be made to use AGPL 3.0 licence instead.

Expecting pull requests from all affected repos to be linked to this issue.

Useful article(s)
https://www.r-bloggers.com/2020/04/why-dash-uses-the-mit-license-and-not-a-copyleft-gpl-license/

Repos for AGPL

  • @code-collabo/website
  • @code-collabo/blog
  • @code-collabo/community-doc
  • @code-collabo/node-mongo-cli
  • @code-collabo/git-and-github-for-collaboration
  • and all repos under @code-collabo/git-and-github-for-collaboration

Repos for ISC

  • @code-collabo/node-mongo-api-boilerplate-templates
  • @code-collabo/css

Repos for mixed licences
These will most times be parent repos where some sub-projects use AGPL and some others use ISC. The licence file will contain author name, the sub-projects and the types of licences they use.

  • @code-collabo/node-mongo
  • @code-collabo/docs
  • @code-collabo/.github

License content for. github repo: The type of License used in @code-collabo projects defer from project to project. See the licence file of projects.

Dynamically update the number of contributors on shields.io badges found on the CLI and API boilerplate template pages of the node-mongo documentation

Issue description

We have our own CLI contributors badge and API boilerplate templates badge. These badges were made using shields.io site. We use these badges in their respective pages of the node-mongo documentation. The problem is we manually edit the files to change the number of contributors.

Expected solution

  • The number on the node-mongo documentation's CLI contributors badge should change/update dynamically as the number of contributors from the node-mongo CLI repo increases or decreases.
  • The number on the node-mongo documentation's API boilerplate template contributors badge should change/update dynamically as the number of contributors from the node-mongo API boilerplates templates repo increases or decreases.

Screenshots

None

Additional context

None

Testing checklist

Note: Add the testing checklist below (without this note) to your pull request when submitting your fix. This will guide (you and) the contributors who will review your fix to know what is important to check or test for.

  • The number of contributors on the CLI contributors badge in the node-mongo documentation is now dynamically updated by the CLI repo's number of contributors
  • The number of contributors on the API boilerplate template contributors badge in the node-mongo documentation is now dynamically updated by the API boilerplate templates repo's number of contributors
  • I certify that I ran my checklist

Contribution docs for documentation has no content yet

Issue description

Contributors have no idea of how to contribute to our documentation projects. Add the content for this on this page: https://code-collabo.gitbook.io/collabo-contributor/collabo-documentation-projects/contribute-to-collabo-documentation-projects

Additional context

Borrow ideas from the contributor docs for node mongo and the collabo web app. Follow their trend and you'll be fine.
Although in this case you may want to include gitbook and requesting access to gitbook. If anything is confusing, ask in the appropriate community channel.

The node-mongo-scripts is one of the children projects under node-mongo, but has not been added to the documentation yet

Issue

In the node-mongo doc, there is content for the node-mongo CLI and API boilerplate templates, but the node-mongo-scripts is not yet added to the doc yet:

  • There is no documentation page that describes it as a product/project and what it does
  • Nothing in the doc shows its usage for collabo contributors yet even though the readme says so - #40
  • In the sidebar, there is no link to node-mongo-scripts contributors and node-mongo-scripts release notes

[Ts Revamp]Change file extensions and add types to necessary parameters

description

Change file extensions and add types to necessary parameters , function return statements and variable

Note: All functionalities should work as before.

Testing checklist

Note: Add the testing checklist below (without this note) to your pull request when submitting your fix. This will guide (you and) the contributors who will review your fix to know what is important to check or test for.

  • Types were added to the necessary functions and parameters
  • all code works as before
  • I certify that I ran my checklist

Create documentation guide for the Collabo Web App Figma Design to guide its users

We created an easy-to-use approach to designing an app, and implemented it in the Code Collabo Web App figma design. We named the approach the building-block UI/UX design approach a.k.a Collabo approach.

Creating a doc guide on how to use it will help guide current and future developers and designers of the Collabo Web App. we also hope that it will gain global recognition and usage with time. The doc is to help create awareness.

Create/add walkthrough content for new Code Collabo documentation

Suggested improvement

We now have a new documentation for the code collabo community: https://code-collabo.gitbook.io/docs.
It will be nice to have a walkthrough page that helps the doc user effectively use it.

Additional context

We already have page for it, just here just that it is empty at the moment: https://code-collabo.gitbook.io/docs/collabo-docs-home/collabo-docs-walkthrough

Testing checklist

Note: Add the testing checklist below (without this note) to your pull request when submitting your fix. This will guide (you and) the contributors who will review your fix to know what is important to check or test for.

  • Walkthrough page has been updated with content that helps our users use our documentation effectively.
  • I certify that I ran my checklist

node-mongo docs page and node-mongo-scripts readme does not show users how to use the node-mongo-scripts during development (yet)

Issue

On the readme of the node-mongo-scripts repo, there is a note in there that says:

Contributors are to check the node-mongo documentation for how to plug it into node-mongo projects during development

For now, the node-mongo scripts is only used in the node-mongo-api-boilerplate-templates project. But there is nothing on the node-mongo-scripts readme and in the node-mongo gitbook documentation that shows developers how to use/test/plug the node-mongo-scripts into the node-mongo-api-boilerplate-templates during development.

Note
This is a sub-issue under #42

Project and git workflow sections missing in contributor workflow docs

Issue description

Project and git workflow sections missing in contributor workflow docs.

Testing checklist

Note: Add the testing checklist below (without this note) to your pull request when submitting your fix. This will guide (you and) the contributors who will review your fix to know what is important to check or test for.

  • Project and git workflow sections have been added
  • I certify that I ran my checklist

[Create Collabo App v1.0.0] Convert/migrate the node-mongo CLI project from Javascript to typescript

  1. Important
    • All functionalities must work as before
  2. Conversion/Migration details
    1. Initial Setup:
      • Setup of typescript and tsconfig file
      • File extension change from .js to .ts (for all concerned files), Adding types and whatever is necessary to get typescript working properly too.
    2. Running CLI from Typescript generated code:
      • Make the CLI run from the typescript generated code i.e. if user/contributor runs the node-mongo command, the code in the generated dist folder should run. Not the code inside of src folder.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.