A `CONTRIBUTING.md` is needed

[SantanaSP]

Summary

We need a CONTRIBUTING.md to describe our code structure and workflow to newly joined developers.

Expected Behaviour

A CONTRIBUTING.md, which describes things below:

1. Technology stack of our full project.
2. Structure of this repo.
   1. Packages information and whether they are private.
   2. Files structures and toolchains.
3. workflow for community collaborators.
   1. Your First Contribution section.
   2. Issues collaboration process.
   3. QAs can be opened in Github Discussion.
   4. How-to submit a new PR, i.e., engage in code work.
   5. The principles.
      1. The principle of coding style.
      2. The principle of commit message & PR title.
      3. The principle of a new issue.

4. An avatars list of contributors.

   A short contributing section in README.md to show how to set up the project and a link to CONTRIBUTING.md, including:

• Technology stack of our full project.
• How-to set up the project.
• How-to build the packages.
• How-to publish the pages.

Any proposal of the above features could be given in the comments area.

Solution

After all sections get discussed and there are proposals of them in comments area, one of the maintainers would start writing down a CONTRIBUTING.md and add content to README.md. PRs are always welcome even if they just partly resolve this issue.

Alternative

Additional context

Contributing Guidelines

References

https://github.com/rollup/plugins/blob/master/.github/CONTRIBUTING.md

Roadmap

[SantanaSP]

Source issues:

• 157

• 159

• 166

• 161