Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (41 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

52 lines (41 loc) · 2.3 KB

Contribution Instructions

We welcome and appreciate contributions from the community to enhance our AI-focused button library. Please follow the steps below to contribute:

  1. Fork the Repository:

    • Navigate to the main repository: Empire Code Foundation UI.
    • Click on the "Fork" button in the upper-right corner of the page to create a copy of the repository under your GitHub account.

  2. Clone Your Fork:

    • Clone the forked repository to your local machine using the following command: 
      git clone https://github.com/YOUR-USERNAME/ui.git
    • Replace YOUR-USERNAME with your GitHub username.

  3. Create a New Branch:

    • Before making any changes, create a new branch from DesignTeam2-Stage for your work: 
      git checkout -b your-feature-branch origin/DesignTeam2-Stage
    • Replace your-feature-branch with a meaningful name for your branch.

  4. Implement Your Changes:

    • Follow the roadmap and guidelines provided in this document to develop your feature or fix.
    • Make sure each button has its own route.ts file that handles specific logic and API calls.

  5. Commit Your Changes:

    • Once your changes are ready, commit them with a descriptive commit message: 
      git add .
git commit -m "Add [Feature]: Description of the feature or fix"

  6. Push Your Changes:

    • Push your changes to your forked repository: 
      git push origin your-feature-branch

  7. Create a Pull Request:

    • Navigate to the original repository: Empire Code Foundation UI.
    • Click on the "Compare & pull request" button.
    • Ensure your pull request is targeted at the DesignTeam2-Stage branch.
    • Provide a detailed description of your changes and any relevant information.

  8. Wait for Review:

    • One of our team members will review your pull request. Please be patient as we review your contribution.

  9. Incorporate Feedback:

    • If any changes or improvements are requested, make the necessary updates and push them to your branch. The pull request will automatically update.

Thank you for contributing to the Empire Code Foundation UI project! Your efforts help make this library better for everyone.