Skip to main content

Contributing

info

We at GenesisX, are on the lookout for passionate individuals who can join us as contributors.

You can contribute to GenesisX in multiple ways:

  • Raise an Issue on the GenesisX repo, with an issue you encountered or a feature request you would like to see in GenesisX.
  • Contribute a new module to GenesisX.
  • Pick up a ticket.
  • Contribute to Docs.

If you are interested in contributing to this project, have a look at the issues in the Issues of the section, branch out from master branch and raise a PR to the master branch only.

Rampup for contribution​

In order to understand GenesisX in more detail please go through below material.

Its important to complete these steps so that you can be onboarded to the development team.

Step 1 : Marcel Course​

Please enroll and complete this marcel course : 30-50 mins

Step 2 : KT Recordings​

Please go through these recordings for deepdive and other offerings of GenesisX. Please request for the recording access (if required) from Archana Raina

Step 3: Documentation​

  • GenesisX Documentation, please go through the documentation around package and follow the contributor guidelines section throughly.

Step 4: Code Access & Handson​

Step 5 Last : Ready for contribution​

Once you have done above steps , please reach out to Archana Raina, Varkichan , Lalit Negi for including into the team and picking up tasks

Guidelines​

Refer guidelines here Guidelines

Contributing to a New Module​

Everything in GenesisX is a generator, so if you are looking to contribute to a new module of GenesisX, the workflow would be as follows-

  • Raise an Issue on the Repo with a new Feature Request and tag Vinci or Ankit to it. (it might also help to ping them directly)
  • Discuss with the product owners on the scope of the module.
  • Create a Generator for the module.
  • Raise a PR.
  • Update the Docusaurus documentation also

Contributing to Docs​

The docs section is broken down into 3 main areas

  1. Docs- Technical information on how to go about setting up and working with GenesisX.
  2. Kitchen Sink - Code Snippets, tips and tricks to solve our day to day problems.
  3. Case studies - Honest experiences of consumers after working with GenesisX.

Running docs locally​

After the usual npm / yarn install you can run docs locally using the following command

yarn nx serve docs

Adding a Page:​

Adding a page to the docs section requires 2 steps

  1. Create a markdown file under the relevant folder
    • Ensure the id: field matches the filename, and title: matches the title of the page.
  2. Add your page to the array of page links in the sidebar.js file, use the value in the id field.