github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Minor CONTRIBUTING fixes

Browse source
This commit is contained in:
Justin Mayer 2019-11-12 14:20:50 -08:00
commit 74815af6e2
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.rst
View file

@ -22,7 +22,7 @@ Before you ask for help, please make sure you do the following:
3. Try reproducing the issue in a clean environment, ensuring you are using: 3. Try reproducing the issue in a clean environment, ensuring you are using:
* latest Pelican release (or an up-to-date git clone of Pelican master) * latest Pelican release (or an up-to-date Git clone of Pelican master)
* latest releases of libraries used by Pelican * latest releases of libraries used by Pelican
* no plugins or only those related to the issue * no plugins or only those related to the issue
@ -71,7 +71,7 @@ The #pelican IRC channel
* Because of differing time zones, you may not get an immediate response to your * Because of differing time zones, you may not get an immediate response to your
question, but please be patient and stay logged into IRC — someone will almost question, but please be patient and stay logged into IRC — someone will almost
always respond if you wait long enough (it may take a few hours). always respond if you wait long enough (it may take a few hours).
* If you don't have an IRC client handy, use the webchat_ for quick feedback. * If you don't have an IRC client handy, use the webchat_.
* You can direct your IRC client to the channel using this `IRC link`_ or you * You can direct your IRC client to the channel using this `IRC link`_ or you
can manually join the ``#pelican`` IRC channel on the `freenode IRC network`_. can manually join the ``#pelican`` IRC channel on the `freenode IRC network`_.
@ -94,7 +94,7 @@ Using Git and GitHub
* `Create a new git branch`_ specific to your change (as opposed to making * `Create a new git branch`_ specific to your change (as opposed to making
your commits in the master branch). your commits in the master branch).
* **Don't put multiple unrelated fixes/features in the same branch / pull request.** * **Don't put multiple unrelated fixes/features in the same branch / pull request.**
For example, if you're hacking on a new feature and find a bugfix that For example, if you're working on a new feature and find a bugfix that
doesn't *require* your new feature, **make a new distinct branch and pull doesn't *require* your new feature, **make a new distinct branch and pull
request** for the bugfix. request** for the bugfix.
* Add a ``RELEASE.md`` file in the root of the project that contains the * Add a ``RELEASE.md`` file in the root of the project that contains the