Skip to content

Improve CONTRIBUTING.md for new contributors #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AKSrivastava28 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve CONTRIBUTING.md for new contributors #505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@
# Contributing Guidelines for `spopt`

Thank you for your interest in contributing! We work primarily on Github. Please review the contributing procedures [here](http://pysal.org/getting_started#for-developers) and [here](https://github.com/pysal/pysal/wiki/GitHub-Standard-Operating-Procedures) so that we can accept your contributions! Alternatively, contact someone in the [development chat channel](https://gitter.im//pysal/pysal).
Thank you for your interest in contributing to `spopt`! We work primarily on
GitHub and welcome contributions in the form of bug reports, documentation
improvements, and code enhancements.

Please review the general PySAL contributing procedures here:
- http://pysal.org/getting_started#for-developers
- https://github.com/pysal/pysal/wiki/GitHub-Standard-Operating-Procedures

## Style and format
Alternatively, you can contact contributors via the PySAL development chat:
https://gitter.im/pysal/pysal

1. At the time of this writing, Python 3.10, 3.11, and 3.12 are the officially supported versions.
2. This project implements the linting and formatting conventions of [`ruff`](https://docs.astral.sh/ruff/) on all incoming Pull Requests. To ensure a PR is properly linted and formatted prior to creating a Pull Request, [install `pre-commit`](https://pre-commit.com/#installation) in your development environment and then [set up the configuration of pre-commit hooks](https://pre-commit.com/#3-install-the-git-hook-scripts).

## Getting Started

This document provides basic guidance for setting up a local development
environment for `spopt`. It is intended to complement the broader PySAL
developer documentation linked above.


## Installation (Development)

First, fork the repository on GitHub and clone your fork locally:

```bash
git clone https://github.com/<your-username>/spopt.git
cd spopt