Skip to content

Latest commit

 

History

History
72 lines (41 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

72 lines (41 loc) · 2.69 KB
Raw

Contributing to the Handbook

First off, thank you for considering contributing to this SWOT community handbook! We're excited to have a community interested in improving this project. Everyone is welcome to contribute, and we value the input you have.

This document provides standard guidelines for people who want to contribute to the project. If you're thinking about contributing, please start by reading this guide.

Code of Conduct

We have a Code of Conduct in place. By participating in this project, you agree to abide by its terms.

Getting Started

  • Fork the repository: Start by forking the repository and then clone it to your local machine. This gives you the freedom to experiment away from the original project.

    git clone https://github.com/YOUR_USERNAME/SWOT-OpenToolkit.git

  • Set up: Follow the setup guidelines in the README to get the project up and running locally.

  • Find an issue to work on: Look for issues labeled Good First Issue or Help Wanted if you're new to the project.

How to Submit Changes

Once you've made changes, you can submit them by creating a Pull Request. Here's how:

  1. Create a new branch: Create a new branch to work on.

    git checkout -b my-feature-branch

  2. Commit your changes: Make sure to write meaningful commit messages.

    git add .
git commit -m "Add a new feature"

  3. Push to your Fork:

    git push origin my-feature-branch

  4. Submit a Pull Request: Go to your fork on GitHub and click the "New Pull Request" button. Provide a general summary of the changes in the title and a description of what you've added or changed. You can use the PULL REQUEST TEMPLATE as a guidence.

  5. Code Review: A core contributor will review your changes and provide feedback. Make any required changes.

  6. Merge: Once your changes are approved, they will be merged into the main codebase.

Contribution Guidelines

Coding Standards

Please ensure your code adheres to the existing styles and standards of the project. Chatgpt can do some basic and tedious formatting.

Documentation

If you're adding a new feature, make sure to also update or add new documentation to reflect your changes.

Testing

All new features should come with appropriate unit tests.

Reporting Bugs

If you find a bug, please open an issue with a detailed description and steps for how to reproduce the problem. This is a ISSUE TEMPLATE for your convinence.

We're thrilled you're considering contributing to SWOT science handbook, and we can't wait to see what you build. Thank you!