momentum.sh
  • 💡Introduction to Momentum
    • Overview
    • How can momentum help you?
    • Why is it open source
    • Contributing to momentum
    • Troubleshooting & Feedback
  • Getting Started
    • Hers's what you will need
    • Installation
      • Cloud Integrations (Optional)
        • Portkey
        • Firebase
        • Setting up Github App
        • Enabling Github Auth on Firebase
        • Google Cloud
    • Running Momentum
    • Known bugs & fixes
  • Using Momentum
    • Underlying API structure
    • Auth
    • Logging in
    • User Registration
    • Parsing codebase
    • Getting list of all parsed projects
    • Getting list of all branches in a project
    • Listing all endpoints of a branch
    • Understanding Changes & Impacts
    • Generating Blast Radius
    • Get Flow Graph
    • Get Dependencies
    • Get More Dependencies (AI)
    • Getting code of a specific node
    • Testing your code
    • Generating a test plan
    • Setting up the test plan
    • Preferences
      • Setting preferences of a specific endpoint
      • Getting preferences for specific endpoint
    • Generating tests
  • Using Momentum CLI
Powered by GitBook
On this page

Was this helpful?

  1. Introduction to Momentum

Contributing to momentum

PreviousWhy is it open sourceNextTroubleshooting & Feedback

Last updated 10 months ago

Was this helpful?

We welcome and deeply appreciate any contributions to momentum. No matter how small, every contribution is valuable!

Contributions can be of the form:

  1. Documentation : Help improve our docs! If you fixed a problem, chances are others faced it too.

  2. Code : Help us make improvements to existing features and build new features for momentum.

  3. Tests : Help us make momentum resilient by contributing tests.

Contributors should follow the

When contributing to momentum, ensure that:

  1. You have looked at to see if there's something you can do for us.

  2. If there is a major feature you would like to work on that is not present on the issues page, before implementation and discuss it with the core team.

  3. Aim for 100% test coverage when contributing new features. Tests help verify your code and protect against future changes.

  4. Ensure that all your changes run end to end locally, include screenshots of local test results wherever possible in your PR.

  5. Once the code is ready, raise a pull request towards the main repo for peer review and acceptance.

To contribute:

  1. Fork the repository.

  2. Create a new branch (git checkout -b feature-branch).

  3. Commit your changes (git commit -am 'Add new feature').

  4. Push to the branch (git push origin feature-branch).

  5. Open a Pull Request.

💡
code of conduct
open issues
open an issue