Permalink
Browse files

update contributing and README.md with gitter (#400)

  • Loading branch information...
1 parent 4ac9b80 commit b1bda5b4de2ed73a29d73e9574243d3041990a84 @dustinvtran dustinvtran committed on GitHub Jan 11, 2017
Showing with 13 additions and 43 deletions.
  1. +3 −0 README.md
  2. +10 −43 docs/tex/contributing.tex
View
@@ -2,6 +2,7 @@
[![Build Status](https://travis-ci.org/blei-lab/edward.svg?branch=master)](https://travis-ci.org/blei-lab/edward)
[![Coverage Status](https://coveralls.io/repos/github/blei-lab/edward/badge.svg?branch=master&cacheBuster=1)](https://coveralls.io/github/blei-lab/edward?branch=master)
+[![Join the chat at https://gitter.im/blei-lab/edward](https://badges.gitter.im/blei-lab/edward.svg)](https://gitter.im/blei-lab/edward?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[Edward](http://edwardlib.org) is a Python library for probabilistic modeling,
inference, and criticism. It is a testbed for fast experimentation and research
@@ -48,3 +49,5 @@ visualization with TensorBoard.
## Resources
+ [Edward website](http://edwardlib.org)
++ [Edward Gitter channel](http://gitter.com/blei-lab/edward)
++ [Edward releases](https://github.com/blei-lab/edward/releases)
@@ -4,16 +4,17 @@ \subsection{Contributing}
Interested in contributing to Edward? We appreciate all kinds of help!
-\subsubsection{Bug reports, feature requests, user-related questions}
+\subsubsection{Community}
-Report any bugs in Edward's
-\href{https://github.com/blei-lab/edward/issues}
-{Github issues}.
-We also appreciate feature requests so that we can prioritize
-development according to the users.
-We plan to have a
-mailing list for Edward users in the future,
-but for now also submit usage questions there.
+For general discussion about Edward, use Edward's
+\href{http://gitter.com/blei-lab/edward}{Gitter channel}.
+For example, it is used to get help with installation, coding and
+debugging in Edward, and probabilistic modeling.
+(We also plan to have a mailing list-like option in the future.)
+
+For development discussion about Edward, use Edward's
+\href{https://github.com/blei-lab/edward/issues}{Github issues tracker}.
+For example, it is used to submit bug reports and feature requests.
\subsubsection{Pull requests}
@@ -155,37 +156,3 @@ \subsubsection{Suggested private developer workflow}
Now simply create a pull request via the Github UI on the public repo.
Once project owners review the pull request, they can merge it.
\href{http://stackoverflow.com/questions/10065526/github-how-to-make-a-fork-of-public-repository-private/30352360\#30352360}{Source}
-
-\subsubsection{Internal}
-
-\begin{itemize}
-\item
- For developers with push permission to Edward's repo, see
- \href{https://github.com/stan-dev/stan/wiki/Developer-Process#information-to-include-in-pull-request}{Stan's
- process} for how to name branches. Do not merge your own pull
- requests or ever push to master. Someone should always review your
- code. After merging (or deciding to close the request without
- merging), always delete the branch from the repo.
-\item
- \textbf{Issue labeling system.} We use
- \href{https://github.com/stan-dev/stan/issues}{Stan's labeling system}.
- While several labels obviously don't apply to us, it's better than the
- default labels.
-\item
- \textbf{Packaging and submitting to PyPI.} First, update the version
- number in \texttt{version.py}. Second, follow
- \href{https://packaging.python.org/en/latest/distributing/\#packaging-your-project}{these
- steps}. For shorthand, the sequence of commands is
-
-\begin{lstlisting}[class=JSON]
-python setup.py sdist
-python setup.py bdist_wheel
-twine upload dist/*
-\end{lstlisting}
-
- Third, tag the release on Github and note the new additions when
- tagging this release. You can do this by comparing commits from the
- previous tagged release to master. A link that compares tagged commits
- to master is available on the
- \href{https://github.com/blei-lab/edward/releases}{releases page}.
-\end{itemize}

0 comments on commit b1bda5b

Please sign in to comment.