Skip to content

Pull Request Guide for azcii

Mahdi Qiamast edited this page Jan 29, 2023 · 1 revision

Introduction

Welcome to the azcii pull request guide. This guide will walk you through the process of submitting a pull request (PR) for the package.

Prerequisites

Before submitting a PR, make sure you have:

  • A Github account
  • Forked the azcii repository
  • Cloned the forked repository to your local machine
  • Created a new branch for your changes
  • Making changes
  • Make the necessary changes to the package. You can add new art, customize existing art, add new commands, or improve performance. Make sure your changes are well-commented and follow the code style guidelines of the project.

Testing

Test your changes locally to make sure everything is working as expected. Make sure that any existing and new unit tests pass.

Submitting the PR

  1. Push your changes to your forked repository
  2. Go to the azcii repository on Github and click on the "Pull requests" tab
  3. Click on the "New pull request" button
  4. Select the branch you just pushed from the "compare" dropdown menu
  5. Fill out the pull request template with a description of your changes and any relevant information
  6. Click on the "Create pull request" button
  7. Review process
  8. Your PR will be reviewed by the azcii maintainers. They will review the code, test it, and provide feedback. You may need to make changes based on their feedback before your PR can be merged.

Merging

Once your PR has been reviewed and approved, it will be merged into the azcii repository. Congratulations on your contribution!

Additional resources

For more information on pull requests, check out the Github documentation

Clone this wiki locally