Contribute to Our Project

Introduction

We welcome contributions to our project! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated. This guide will walk you through the process of contributing to our project.

Cloning the Repository

First, you'll need to create a local copy of our repository:

  1. Fork the repository on GitHub to your own account.
  2. Clone your forked repository to your local machine:
    3. git clone https://github.com/cottrellashley/relativisticpy.git
  3. Change into the repository's directory:
    4. cd relativisticpy

Submitting Pull Requests

When you've made some changes that you'd like to submit, follow these steps:

  1. Create a new branch for your changes:
    2. git checkout -b feature-branch-name
  2. Make your changes and commit them with a clear commit message.
  3. Push the branch to your GitHub repository.
  4. Go to the original repository on GitHub, and you'll see a prompt to submit a pull request.
  5. Fill out the pull request form and submit it.

Our team will review your pull request and merge it into the project after approval.

Submitting Issues and Bugs

If you find bugs or issues, we encourage you to report them:

  1. Go to the 'Issues' tab in the GitHub repository.
  2. Click 'New Issue' and provide a detailed description of the issue or bug.
  3. Submit the issue for our team to review.

We appreciate detailed reports as they help us make the project better for everyone.

Additional Contribution Guidelines

Please adhere to our coding standards and guidelines when contributing. This ensures consistency and quality throughout the codebase. Our guidelines are available in the repository's documentation.