Make a Contribution to listwiz

In this tutorial, we will learn how to contribute to listwiz.

Open-source projects are typically hosted on platforms like GitHub, GitLab, or others, with the source code managed using Git. In this tutorial, we will use GitHub as an example. To make a contribution, you need to have a GitHub account. You can create an account by navigating to GitHub: http://github.com. If you are in education, you can apply for a specific education account here: https://education.github.com.

Now that you have your account, there are a few more initial steps that you will need to take before you can start contributing to the project. The first step is to create a fork of the project and bring a copy of the project to your computer:

• 1. Forking and Cloning the repository

Now you are ready to start contributing. There are several tasks that you can do, such as including documentation, writing tests, or implementing functions. You can nagivate to the issues tab of the repository and find an issue that you would like to work on. Once you choose what you want to work on, remember to create a branch before you start implementing.

• 2. Creating a branch

• 3. Contributing to the documentation

• 4. Contributing a test

• 5. Contributing a new function

In each section, you will find information on how to implement each step, as well as a checklist of things you need to complete. These include compiling the documentation, running the test suite, and committing your changes!

Now you are ready to ask for your new developed code to be part of the source code of the project! For that you need to follow the instructions:

• 6. Pushing to Github and Opening a Pull Request

Thus as a summary the steps you have to take can be summarised as follows:

• 1. Forking and Cloning the repository
  • Forking the repository
  • Cloning the repository
• 2. Creating a branch
• 3. Contributing to the documentation
  • Checking the modification
  • Committing the change
  • Checklist
• 4. Contributing a test
  • Install the package in development mode
  • Running the test suite
  • Committing the change
  • Checklist
• 5. Contributing a new function
  • Install the package in development mode
  • Implementing your function
  • Documenting your function
  • Testing your function
  • Committing the change
  • Checklist
• 6. Pushing to Github and Opening a Pull Request
  • Pushing the change to Github
  • Opening a Pull Request
  • Making further modifications