Skip to content

Commit

Permalink
Updated contributing materials
Browse files Browse the repository at this point in the history
  • Loading branch information
seanlaw committed Jul 19, 2024
1 parent 1930d81 commit 3077d0d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Contributing to documentation is the easiest way to get started. Providing simpl

## Code

Code contributions are always welcome, from simple bug fixes, to new features. To contribute code please [fork the project](https://github.com/TDAmeritrade/stumpy/fork) into your own repository, make changes there, run [black](https://github.com/python/black) and [flake8](http://flake8.pycqa.org/en/latest/) on your code, add tests for bugs/new features, and then submit a pull request. If you are fixing a known issue please add the issue number to the PR message. If you are fixing a new issue feel free to file an issue and then reference it in the PR. You can [browse open issues](https://github.com/TDAmeritrade/stumpy/issues), or consult the [project roadmap](https://github.com/TDAmeritrade/stumpy/issues/1), for potential code contributions. Fixes for issues tagged with 'help wanted' are especially appreciated.
Code contributions are always welcome, from simple bug fixes, to new features. To contribute code please [fork the project](https://github.com/TDAmeritrade/stumpy/fork) into your own repository, make changes there, run [black](https://github.com/python/black) and [flake8](http://flake8.pycqa.org/en/latest/) on your code, add tests for bugs/new features, and then submit a pull request. If you are fixing a known issue please add the issue number to the PR message. If you are fixing a new issue feel free to file an issue and then reference it in the PR. You can [browse open issues](https://github.com/TDAmeritrade/stumpy/issues) for potential code contributions. Fixes for issues tagged with 'help wanted' are especially appreciated.


10 changes: 5 additions & 5 deletions docs/Contribute.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"source": [
"## Git and GitHub\n",
"\n",
"You don't need a [GitHub](https://github.com/) account to use STUMPY but you do need an account if you want to make a code or documentation contribution. This GitHub account will allow you to contribute to many of the most popular open source projects. Additionally, it will give you a place to store, track, and coordinate progress on your own projects. GitHub is a `remote repository` for the version control system `git`. `Git` is a tool that tracks changes in projects by constructing a directed acyclic graph (fancy way of allowing us to create `branches`, `revert` changes, and identify `conflicts`). You can use `git` on your local machine but when you want to save your work or collaborate with other team members, you `push` your work to a `remote` repository. In this case, that `remote` will be GitHub.\n",
"You don't need a [GitHub](https://github.com/) account to use STUMPY but you do need an account if you want to make a code or documentation contribution. This GitHub account will allow you to contribute to many of the most popular open source projects. Additionally, it will give you a place to store, track, and coordinate progress on your own projects. GitHub is a `remote repository` for the version control system `git`. `Git` is a versioning tool that tracks changes in projects by constructing a directed acyclic graph (fancy way of allowing us to create `branches`, `revert` changes, and identify `conflicts`). You can use `git` on your local machine but when you want to save your work or collaborate with other team members, you `push` your work to a `remote` repository. In this case, that `remote` will be GitHub.\n",
"\n",
"With all of that in mind, you'll also need to [install git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).\n",
"\n",
Expand All @@ -40,7 +40,7 @@
"source": [
"## Find your contribution\n",
"\n",
"You've decided that you want to contribute but how do you approach a new project and figure out where you can help? This will feel like like trying to jump into a conversation that's been happening for months (or years) and can often be intimidating. If you've used the project before, you'll be more familiar with its structure and API but you probably haven't \"peeked behind the curtain\". The best place to get started is the list of [Issues](https://github.com/TDAmeritrade/stumpy/issues). These are requests/changes/bugs that other people have identified. Feel free to peruse the list to get a feel for all of the ongoing work in the project. Often, maintainers will have a label system to organize the issues. These labels may include things like `documentation` or `enhancement`. For new contributors, many projects have a [good first issue label](https://github.com/TDAmeritrade/stumpy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).\n",
"You've decided that you want to contribute but how do you approach a new project and figure out where you can help? This will feel like like trying to jump into a conversation that's been happening for months (or years) and can often be intimidating. If you've used the project before, you'll be more familiar with its structure and API but you probably haven't \"peeked behind the curtain\". The best place to get started is the list of [Issues](https://github.com/TDAmeritrade/stumpy/issues). These are feature requests/changes/bugs that other people have identified. Feel free to peruse the list to get a feel for all of the ongoing work in the project. Often, maintainers will have a labeling system to organize the issues. These labels may include things like `documentation` or `enhancement`. For new contributors, many projects have a [good first issue label](https://github.com/TDAmeritrade/stumpy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).\n",
"\n",
"Your next stop, should always be [CONTRIBUTING.md](https://github.com/TDAmeritrade/stumpy/blob/master/CONTRIBUTING.md). Here, the maintainers outline any guidance they have for contributors,\n",
"\n",
Expand Down Expand Up @@ -68,7 +68,7 @@
"\n",
"First, you need to create a copy of the repository for you to work off of; this is called a `fork`. Here are instructions on [forking a repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo). Now you have your own copy associated with your GitHub account.\n",
"\n",
"Next, you need to `clone` this copy of the repository. This simply downloads it to your computer so that you can work on it. Here are instructions on [cloning a repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository). Now that you have a copy downloaded onto your computer. *remember* to clone your fork and not [STUMPY](https://github.com/TDAmeritrade/stumpy).\n",
"Next, you need to `clone` this copy of the repository. This simply downloads it to your computer so that you can work on it. Here are instructions on [cloning a repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository). It's super important to *remember* to clone your fork and not [STUMPY](https://github.com/TDAmeritrade/stumpy).\n",
"\n",
"Then, you'll need to create a `branch`. Here's an overview of [how git branches work](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging) but if you're working in the command line, then you probably need to type `git checkout -b branch_name`. In this case, `branch_name` should be replaced with something descriptive about the change that you are making like `change_incorrect_variable` or `document_x`.\n",
"\n",
Expand Down Expand Up @@ -105,11 +105,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Make your Changes\n",
"# Setting Up Your Environment\n",
"\n",
"When working on a new project, there are often going to be dependencies. In order to isolate dependencies between different projects, it's a good practice to use a virtual environment. STUMPY supports both [venv](https://docs.python.org/3/library/venv.html) and [conda](https://docs.conda.io/en/latest/). After creating and activating either of these virtual environments, any dependencies you install will be isolated (so they don't break anything else on your system).\n",
"\n",
"First, install the dependencies using the [From Source Section](https://stumpy.readthedocs.io/en/latest/install.html#from-source) of the installation instructions. If you are building STUMPY within a conda environment, then you may consider using the `conda.sh` shell script which will automatically assist you in installing all of the required dependencies required for testing. \n",
"First, if you are using `venv` then you can install STUMPY and all of its the dependencies using the convenient `./setup.sh dev`. If you are building STUMPY within a `conda` environment, then you may consider using the `./conda.sh` shell script which will automatically assist you in installing all of the required dependencies required for STUMPY development. \n",
"\n",
"A good check to make sure everything is working 100% is to run the unit tests. For STUMPY, we have scripts to help you do that. You'll run `./setup.sh dev && ./test.sh`. In some cases, you may notice an uninstallation message for STUMPY but don't worry. This happens if you have had previously installed STUMPY as the `./setup.sh dev` command first uninstalls any existing version of STUMPY and then it will re-installs it from source (the local, cloned, development version). So, everything should be all set.\n",
"\n",
Expand Down

0 comments on commit 3077d0d

Please sign in to comment.