Skip to content

[8pt] [Contribution Guide]: scope analysis, TOC #1673

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

Closed
2 tasks done
veod32 opened this issue Dec 3, 2020 · 1 comment
Closed
2 tasks done

[8pt] [Contribution Guide]: scope analysis, TOC #1673

veod32 opened this issue Dec 3, 2020 · 1 comment
Assignees

Comments

@veod32
Copy link
Collaborator

veod32 commented Dec 3, 2020

Part of #1655.

First of all we need to

@veod32 veod32 changed the title [] [Contribution Guide]: scope analysis, TOC, estimation [16pt] [Contribution Guide]: scope analysis, TOC, estimation Dec 3, 2020
@veod32 veod32 self-assigned this Dec 3, 2020
@veod32 veod32 changed the title [16pt] [Contribution Guide]: scope analysis, TOC, estimation [16pt] [Contribution Guide]: scope analysis, TOC Dec 3, 2020
@veod32 veod32 changed the title [16pt] [Contribution Guide]: scope analysis, TOC [8pt] [Contribution Guide]: scope analysis, TOC Dec 3, 2020
@veod32
Copy link
Collaborator Author

veod32 commented Dec 3, 2020

Questions:

  • Who is the TA (target audience) for this guide?

High level draft TOC -- need another round of discussion

  1. Introduction (landing page -- revised https://www.tarantool.io/en/doc/latest/contributing/contributing/)

  2. Code development

    2.1 Coding

    • General workflow
    • Setup
    • Development process
    • Commiting

    2.2 Code review
    2.3 Tests
    2.4 Build (?)
    2.5 Bug reporting (?) -- can be a subtopic

  3. Documentation

  4. Feedbacks and suggestions

  5. Style guides

    • C style guide
    • Lua style guide
    • Documentation style guide

@veod32 veod32 closed this as completed Dec 3, 2020
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