ONBOARDING

Onboarding to OpenQSE

Welcome to the OpenQSE project! This guide will help you get started as a contributor.

Requesting Access

To join the OpenQSE project:

1. Send your GitHub User ID to the project Secretary via OpenQSE Slack

   • Provide your GitHub username (e.g., @yourusername)

2. Access will be granted to the openQSE repositories

3. Default Access Level

   • All new users receive Maintain access by default
   • If you require different access permissions, please specify when requesting access

Contributing to openqse-spec

Once you've been added to the repository, follow these steps to contribute:

1. Clone the repository

   git clone https://github.com/openQSE/openqse-spec.git
   cd openqse-spec

2. Create an Issue

   • Navigate to the Issues tab on GitHub
   • Create a new issue describing the term you want to add or the change you want to make
   • Note the issue number (e.g., #42)

3. Create a branch

   git checkout -b feature/your-branch-name

4. Make your changes

   • Add new terms, update definitions, or improve documentation
   • Review the README for project goals and guidelines

5. Commit and push your changes

   git add .
   git commit -m "Your descriptive commit message"
   git push origin feature/your-branch-name

6. Create a Pull Request

   • Go to the repository on GitHub
   • Click "New Pull Request"
   • Reference the related issue in the PR description (e.g., "Closes #42")
   • Submit the PR for review

For questions or assistance, reach out to the project Secretary or existing contributors.