How to contribute to the OMG Network Knowledge Base
We are really glad you're here, because we need volunteers, content creators, and developers to help this project reach its full potential.
The following is a set of guidelines for contributing to the OMG Network Knowledge Base website and its educational content. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Code of Conduct
How Can I Contribute?
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report
When you are creating a bug report, please include as many details as possible.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
How Do I Submit A (Good) Bug Report?
Bugs are tracked as GitHub issues.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
This section guides you through submitting an enhancement suggestion for the OMG Network Knowledge Base, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion
When you are creating an enhancement suggestion, please include as many details as possible.
How Do I Submit A (Good) Enhancement Suggestion?
Enhancement suggestions are tracked as GitHub issues. When creating an issue, please provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of the OMG Network Knowledge Base which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most users of the OMG Network Knowledge Base.
- Specify the name and version of the OS you're using.
Your First Code Contribution
Unsure where to begin contributing to the OMG Network Knowledge Base? You can start by looking through these
- Good first issue - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
- Do not include issue numbers in the PR title.
- Include screenshots and animated GIFs in your pull request whenever possible.
- End all files with a newline.
Git Commit Messages
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
:art:when improving the format/structure of the code
:racehorse:when improving performance
:memo:when writing docs
:penguin:when fixing something on Linux
:apple:when fixing something on macOS
:checkered_flag:when fixing something on Windows
:bug:when fixing a bug
:fire:when removing code or files
:white_check_mark:when adding tests
:lock:when dealing with security
:arrow_up:when upgrading dependencies
:arrow_down:when downgrading dependencies