Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

77 lines (47 loc) · 2.36 KB
Raw

Contributing Guide

Thank you for considering contributing to our project! We welcome contributions from the community to help make our project even better.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the project repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/ubclaunchpad/StarPort.git

  3. Navigate to the project directory:

    cd StarPort

  4. Install the project dependencies:

    npm install -g aws-cdk
npm install -g typescript
npm intall

  5. Create a new branch for your contribution:

    git checkout -b your-branch-name

Making Changes

Before making any changes, please ensure you follow the steps in the developer guide

Andin general it's expected you to:

  • Familiarize yourself with the project structure and coding conventions.
  • Create clear and concise commit messages for each logical change.
  • Write clear and well-documented code.
  • Test your changes thoroughly to ensure they work as expected.

Submitting a Pull Request

Once you have made the necessary changes and tested them locally, you can submit a Pull Request (PR) to contribute your changes back to the main project repository. Follow these steps:

  1. Commit your changes and push them to your forked repository:

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

  2. Visit the original repository on GitHub and click on the "New Pull Request" button.

  3. Provide a descriptive title and detailed description for your PR, explaining the purpose and changes made.

  4. Submit the Pull Request.

Code Review

Your contribution will undergo a code review process, where the project maintainers will review your changes, provide feedback, and suggest improvements. Please be open to feedback and be responsive during this process.

Code of Conduct

Contributors are expected to adhere to our Code of Conduct at all times. Please review it before making any contributions.

Further Assistance

If you have any questions, need clarification, or require further assistance, feel free to reach out to us through dev[at]ubclaunchpad.com or other in our Discord channels. We're here to help and guide you through the contribution process.