Skip to content

lasp/developer-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

abe75b0 · Jan 3, 2025

History

34 Commits
Jul 25, 2024
Jan 3, 2025
Jan 3, 2025
Nov 7, 2024
Nov 7, 2024
Jan 2, 2025
Jul 25, 2024
Jan 2, 2025
Apr 22, 2024
Nov 7, 2024
Nov 7, 2024
Jul 25, 2024
Jul 25, 2024

Repository files navigation

developer-guide

This repository contains the source code for the LASP developer guide. For more information about purpose, motivation, scope, and contents, see the developer guide here: http://lasp-developer-guide.readthedocs.io/.

Contributing

If you would like to contribute changes to the content of this repository, do the following:

  1. Create a fork of this repository
  2. Make a local clone of your fork:
git clone https://github.com/<username>/developer-guide.git  # For HTTPS
git clone [email protected]:<username>/developer-guide.git  # For SSH
cd developer-guide/
  1. Set your personal fork to point to an origin and upstream remote:
git remote set-url origin [email protected]:<username>/developer-guide.git  # For SSH
git remote add upstream [email protected]:lasp/developer-guide.git  # For SSH

git remote set-url origin https://github.com/<username>/developer-guide.git  # For HTTPS
git remote add upstream https://github.com/lasp/developer-guide.git  # For HTTPS
  1. Install the pre-commit hooks (i.e. pre-commit install) (you may need to pip install pre-commit first)
  2. Create a branch on that personal fork (i.e. git checkout -b <branch-name>)
  3. Commit changes (i.e. git add <file-that-changed.md>, git commit -m <commit-message>)
  4. Push that branch to your fork (i.e. git push origin <branch-name>)
  5. On the lasp repository, create a new pull request
  6. Assign a reviewer
  7. Iterate with the reviewer over any needed changes until the reviewer approves of the pull request. This may require additional commits to the pull request. Once all changes are approved, merge the pull request.

Questions?

Any questions about this effort may be directed to the #ds-best-practices-documentation Slack channel.