Skip to content

Contributing Guidelines

How to contribute to Engineering Knowledge Base?

Adding content to the Engineering Knowledge Base

  • Fork the repository and clone it. Make necessary changes. Create a pull request to merge your changes. Refer to gitflow document for pull request guidelines.
  • Ensure that your content adheres to mkdocs syntax and includes a title. Add images and sub headings for demonstrating your point whereever necessary.

Requesting change for the article in Engineering Knowledge Base

  • Ensure that similar review have't been reported before by searching on Gitlab issues
  • If you're unable to find a similar open issue, open a new one. Be sure to include a title and clear description, as much relevant information as possible. Make sure to include a link to external resource that validates your point. Add images if relevant.

Creating an issue

Fig: Creating an issue

Engineering Knowledge Base is a volunteer effort. We encourage you to contribute as much as possible!

Thanks!

  1. Contributors: Niraj Nepal ↩