Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

92 lines (60 loc) · 3.35 KB
Raw

Contributing to The Legend of King Alexander

Thank you for considering contributing to this repo! We welcome contributions of all kinds, from bug reports and documentation improvements to code enhancements. Please take a moment to review this guide before getting started.

How to Contribute

1. Create an Issue

Before you start working on a fix or a feature, please create an issue to discuss the changes. This helps us to coordinate and prevent duplicate efforts.

  1. Go to the Issues page of the repository.
  2. Click on the "New Issue" button.
  3. Provide a clear and descriptive title for the issue e.g part 2, sentence no.4
  4. Describe the problem or the proposed feature in detail.
  5. Select a label type e.g documentation

2. Fork the Repository

To make changes to the codebase, you need to fork the repository.

  1. Go to the repository.
  2. Click on the "Fork" button at the top right of the page.
  3. This creates a copy of the repository under your GitHub account.

3. Clone Your Fork

Clone your forked repository to your local machine.

git clone https://github.com/{your-github-username}/the_legend_of_king_alexander.git
cd the_legend_of_king_alexander

4. Create a New Branch

Create a new branch to work on your changes. This makes it easier to manage and review your contributions.

git checkout -b your-branch-name

5. Make Your Changes

Make your changes to the codebase. Ensure that your code follows the project's coding standards and conventions.

6. Commit Your Changes

Commit your changes with a meaningful commit message. If your commit fixes an issue, include the issue number in the commit message. for e.g.

git add .
git commit -m "Fixes #123: Description of the fix"

7. Push to Your Fork

Push your changes to your forked repository.

git push origin your-branch-name

8. Create a Pull Request

Once your changes are pushed to your fork, you can create a pull request to merge them into the main repository.

  1. Go to the branches page of your forked repository.
  2. Click on menu options (3 dots) of the branch you created.
  3. Click on "New Pull Request" option.
  4. Select your fork and the branch you worked on.
  5. Provide a clear and descriptive title for the pull request.
  6. Describe the changes you made and the reason for the changes in detail.
  7. Link to any related issues using the `#` symbol followed by the issue number (e.g., `Fixes #123`).
  8. Click on the "Create Pull Request" button.
  9. Request review from reviewers

9. Respond to Feedback

Your pull request will be reviewed by the maintainers. Be prepared to make changes based on their feedback. Engage in the discussion and make necessary adjustments.

Additional Notes

  • Ensure your code is well-documented.
  • Follow the existing coding style.
  • Write tests for new features or changes in functionality.
  • Be respectful and considerate in all communications.

We appreciate your contributions and look forward to collaborating with you! If you have any questions, feel free to reach out by creating an issue or contacting the maintainers.

Thank you!

AI Sensei Team