matthewaltenburg / website

Southern Cross AI's open-source website

Southern Cross AI - Australia's first large language model research initiative

This is a test

Welcome to the Southern Cross AI project's repository, aimed at developing Australia's pioneering and sovereign open-source LLM through collaborative efforts across academia, research, government, and business sectors.This repository hosts the website for documenting and facilitating the collaborative development of Australia's first LLM, serving as a central hub for information, updates, and community engagement.

Getting Involved

Development: Enhance the site's functionality and user experience.

Content: Write documentation, tutorials, and blog posts about the project's progress.

Feedback: Offer suggestions and feedback on the website to ensure it effectively serves the project's needs and the community's expectations.

How to Contribute and Submit a Pull Request

Follow these steps to contribute to the project and submit your changes through a pull request.

Public Preview Branch URL

https://website-jxwq8hwf0-southern-cross-ai.vercel.app/

Step 1: Set Up for Development

1. Fork and Clone the Repository: Clone the project to your local machine to get started.

   git clone https://github.com/Southern-Cross-AI/WebSite.git
   

2. Install Dependencies: Navigate to the project directory and install its dependencies.

   npm install
   

   Alternatively, use yarn or pnpm if you prefer.

3. Start the Development Server: Run the development server to see your changes in real time.

   npm run dev
   

   You can also use yarn dev, pnpm dev, or bun dev based on your setup.

Step 2: Make Your Contribution

1. Create a New Branch: Create a new branch for your changes.

   git checkout -b your-branch-name
   

2. Make Your Changes: Implement the changes or improvements you're contributing.

3. Commit Your Changes: Commit your changes with a descriptive message.

   git add .
   git commit -m "Your descriptive commit message"
   

Step 3: Submit Your Pull Request

1. Push to Your Fork: If it's your first contribution, make sure to fork the repository. Then, push your branch to your fork.

   git push origin your-branch-name
   

2. Open a Pull Request (PR): Navigate to the original repository on GitHub. You should see a prompt to open a pull request with your changes. If not, go to the "Pull requests" tab, click "New pull request", then "compare across forks", and select your branch.

3. Describe Your PR: Provide a concise title and detailed description for your pull request. Explain the changes you've made and their impact.

4. Submit the PR: Submit your pull request. Await feedback or approval from the project maintainers.

---

Important Links:

• Licence
• About Us
• Vision, Mission and Principles
• Feedback or Suggestions
• Privacy Policy
• Terms of Use