OpenStack Application Process

Welcome! This repository handles applications to join the OpenStack organization. Follow the steps below to submit your application.

📋 Prerequisites

• A GitHub account
• Your Discord username (optional)
• Your X (Twitter) username (optional)
• Your email address (preferably matching your GitHub account email)

🚀 How to Apply

Step 1: Fork and Clone the Repository

1. Fork this repository to your GitHub account
2. Clone your fork to your local machine:

   git clone https://github.com/openstackhq/apply.git
   cd apply

Step 2: Create a Branch

Create a new branch for your application:

git checkout -b apply/your-username

Replace your-username with your actual GitHub username.

Step 3: Update members.json

Open the members.json file. Important: You must keep all existing members and add your own entry to the members object.

Add your entry to the existing structure:

{
  "members": {
    "ExistingMember1": {
      "email": "existing1@example.com",
      "discord": "existing1",
      "x": "existing1"
    },
    "ExistingMember2": {
      "email": "existing2@example.com",
      "discord": "existing2",
      "x": "existing2"
    },
    "YourGitHubUsername": {
      "email": "your.email@example.com",
      "discord": "your-discord-username",
      "x": "your-x-username"
    }
  }
}

Important Notes:

• Keep all existing members - Do not remove or modify other members' entries
• Add your entry - Add your information as a new entry in the members object
• Replace YourGitHubUsername with your actual GitHub username (case-sensitive)
• Use your real email address (preferably the one associated with your GitHub account)
• Provide your Discord username (optional, without the # and discriminator)
• Provide your X (Twitter) username (optional, without the @ symbol)

Example: If you're adding yourself as johndoe to an existing file:

{
  "members": {
    "SkidGod4444": {
      "email": "connect.saidev@gmail.com",
      "discord": "dev.unfazed",
      "x": "SaidevDhal"
    },
    "johndoe": {
      "email": "john@example.com",
      "discord": "johndoe",
      "x": "johndoe"
    }
  }
}

Step 4: Commit and Push

git add members.json
git commit -m "Add application for YourGitHubUsername"
git push origin apply/your-username

Step 5: Create a Pull Request

1. Go to the original repository on GitHub

2. Click on "Pull Requests" → "New Pull Request"

3. Set the base branch to apply (not main)

4. Set the compare branch to your fork's branch

5. CRITICAL: Use this exact title format:

   Application for OpenStack by YourGitHubUsername
   

   Replace YourGitHubUsername with your actual GitHub username.

6. Create the pull request

✅ PR Requirements

Your pull request must meet these requirements:

1. PR Title Format: Must be exactly Application for OpenStack by [YourGitHubUsername]

   • ✅ Correct: Application for OpenStack by SkidGod4444
   • ❌ Wrong: Application for OpenStack
   • ❌ Wrong: application for openstack by SkidGod4444
   • ❌ Wrong: My Application

2. File Changes: Only members.json should be modified

   • ✅ Correct: Only members.json is changed
   • ❌ Wrong: Multiple files changed
   • ❌ Wrong: Other files modified

3. JSON Structure: Your entry must follow the exact format shown in the example above

📧 Email Handling

• If your GitHub account has a public email: The workflow will automatically update members.json to use your GitHub account email if it differs from what you provided.
• If your GitHub account email is private: Your provided email will be kept as-is in members.json.

⚠️ Troubleshooting

PR Validation Failed

Issue: "PR title does not match the required format"

• Solution: Ensure your PR title is exactly: Application for OpenStack by YourGitHubUsername

Issue: "Expected only 'members.json' to be changed"

• Solution: Make sure you only modified members.json. Revert any other file changes.

Issue: "Username 'X' not found in members.json"

• Solution: The username in your PR title must exactly match the key in members.json (case-sensitive)

Issue: "Missing 'email' field" or "Missing 'discord' field" or "Missing 'x' field"

• Solution: Ensure all three fields (email, discord, x) are present in your entry

Issue: Modified other members' data

• Solution: Only add your own entry. Do not modify or remove existing members' information. The workflow validates only your entry, but modifying others may cause issues during merge

PR from a Fork

If your PR is from a fork and your email doesn't match your GitHub account:

• The workflow will create a comment on your PR asking you to update the email manually
• Update members.json with the correct email and push the changes
• The workflow will re-run automatically

Workflow Not Running

• Ensure your PR targets the apply branch (not main)
• Check that your PR title matches the exact format required
• Verify that only members.json is changed

🆘 Need Help?

If you encounter any issues or have questions:

1. Check the workflow run logs in the "Actions" tab
2. Review the troubleshooting section above
3. Open an issue in this repository

Good luck with your application! 🎉