If you're interested in contributing to the UpTrain repository, we'd love to have you! Here's a more detailed guide on how to get started:
-
First, fork the repository to your own GitHub account. This will create a copy of the repository that you can make changes to.
-
Next, navigate to the repository on your own account and create a new branch. This is where you'll make your changes and additions. You can do this by running the following command (replacing "YOUR_GITHUB_USERNAME" with your actual GitHub username)
git checkout -b YOUR_GITHUB_USERNAME/somefeature- Now it's time to make changes! You can add new files, modify existing files, or delete files that are no longer needed. To reinstall the UpTrain package with your local changes, run the following in the
uptrainrepository home folder:
pip install .-
Once you've made the changes you want, you'll need to add them to a commit. You can do this by running the command
git add filenamefor each file name you want to add/update. This will add all changes to the next commit. -
Now you're ready to commit your changes. You'll need to provide a commit message that briefly describes the changes you've made. You can do this by running the command (replacing "Add something" with a brief description of your changes)
git commit -m 'Add something'- Finally, you'll need to push your changes to the branch you created in step 2. You can do this by running the command
git push origin YOUR_GITHUB_USERNAME/somefeature- Once your changes are pushed, you can go back to the UpTrain repository on GitHub and make a pull request. This is where you'll describe your changes and ask for them to be reviewed and merged into the main repository.
Thank you for your interest in contributing to UpTrain! We look forward to reviewing your pull request and incorporating your changes ❤️