Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 2.09 KB
Raw

How to Contribute

Welcome to SuperEdge! We'd love your contribution! Here are a few small guidelines.

Code of Conduct

Please do check our Code of Conduct before making contributions.

Certificate of Origin

We require all commits to be signed with DCO to certify that the contributors wrote or otherwise have the right to submit the code they are contributing to the project.

Signed-off-by: Random J Developer <random@developer.example.org>

Contributing to SuperEdge Documentation

Reporting Issues

If you see a documentation issue or requests for SuperEdge website:

  1. Check the issue list for any existing issues.
  2. Create issue using existing template.

Submitting Pull Requests

SuperEdge website contains assets to build the SuperEdge website. It includes:

  • Documentation: Project guidance and user reference
  • Blog: Use cases, community announcements

If you're fixing an issue or want to add new content to the SuperEdge website, submit a PR against the main branch.

  • Fork superedge/website
  • Modify the website code and push to your fork.
  • Submit PR against the SuperEdge main branch.

Guidelines for Pull requests

  • Add label to your PR regarding the language of the documentation. language/en for English or language/zh for Chinese.
  • Create smaller PRs that focus on addressing a single issue.
  • Link to a GitHub issue if it exists.
  • Provide good PR description on what change to make.
  • Maintain clean commit history with meaningful commit messages.
  • Resolve any merge conflicts with main branch. Or we can't merge your change.

Communication

For real time discussion, join us on Slack.

To discuss ideas and requests, please go to SuperEdge Forum or submit an GitHub Issue.