Skip to content

Commit 1128ba8

Browse files
author
Janneke van der Zwaan
committed
Convert other md files to rst
1 parent 57414bc commit 1128ba8

File tree

4 files changed

+47
-32
lines changed

4 files changed

+47
-32
lines changed

{{cookiecutter.project_slug}}/CHANGELOG.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
###########
2+
Change Log
3+
###########
4+
5+
All notable changes to this project will be documented in this file.
6+
This project adheres to `Semantic Versioning <http://semver.org/>`_.
7+
8+
[Unreleased]
9+
************
10+
11+
Added
12+
-----
13+
14+
* Empty Python project directory structure

{{cookiecutter.project_slug}}/CODE_OF_CONDUCT.md renamed to {{cookiecutter.project_slug}}/CODE_OF_CONDUCT.rst

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# Contributor Covenant Code of Conduct
1+
###############################################################################
2+
Contributor Covenant Code of Conduct
3+
###############################################################################
24

3-
## Our Pledge
5+
Our Pledge
6+
**********
47

58
In the interest of fostering an open and welcoming environment, we as
69
contributors and maintainers pledge to making participation in our project and
@@ -9,7 +12,8 @@ size, disability, ethnicity, gender identity and expression, level of experience
912
education, socio-economic status, nationality, personal appearance, race,
1013
religion, or sexual identity and orientation.
1114

12-
## Our Standards
15+
Our Standards
16+
*************
1317

1418
Examples of behavior that contributes to creating a positive environment
1519
include:
@@ -31,7 +35,8 @@ Examples of unacceptable behavior by participants include:
3135
* Other conduct which could reasonably be considered inappropriate in a
3236
professional setting
3337

34-
## Our Responsibilities
38+
Our Responsibilities
39+
********************
3540

3641
Project maintainers are responsible for clarifying the standards of acceptable
3742
behavior and are expected to take appropriate and fair corrective action in
@@ -43,7 +48,8 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
4348
permanently any contributor for other behaviors that they deem inappropriate,
4449
threatening, offensive, or harmful.
4550

46-
## Scope
51+
Scope
52+
*****
4753

4854
This Code of Conduct applies both within project spaces and in public spaces
4955
when an individual is representing the project or its community. Examples of
@@ -52,7 +58,8 @@ address, posting via an official social media account, or acting as an appointed
5258
representative at an online or offline event. Representation of a project may be
5359
further defined and clarified by project maintainers.
5460

55-
## Enforcement
61+
Enforcement
62+
***********
5663

5764
Instances of abusive, harassing, or otherwise unacceptable behavior may be
5865
reported by contacting the project team at {{ cookiecutter.code_of_conduct_email }}. All
@@ -65,9 +72,8 @@ Project maintainers who do not follow or enforce the Code of Conduct in good
6572
faith may face temporary or permanent repercussions as determined by other
6673
members of the project's leadership.
6774

68-
## Attribution
75+
Attribution
76+
***********
6977

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
78+
This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4,
7179
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72-
73-
[homepage]: https://www.contributor-covenant.org
Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Contributing guidelines
1+
############################
2+
Contributing guidelines
3+
############################
24

3-
We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
5+
We welcome any kind of contribution to our software, from simple comment or question to a full fledged `pull request <https://help.github.com/articles/about-pull-requests/>`_. Please read and follow our `Code of Conduct <CODE_OF_CONDUCT.rst>`_.
46

57
A contribution can be one of the following cases:
68

@@ -10,30 +12,33 @@ A contribution can be one of the following cases:
1012

1113
The sections below outline the steps in each case.
1214

13-
## You have a question
15+
You have a question
16+
*******************
1417

15-
1. use the search functionality [here](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues) to see if someone already filed the same issue;
18+
1. use the search functionality `here <https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues>`_ to see if someone already filed the same issue;
1619
1. if your issue search did not yield any relevant results, make a new issue;
1720
1. apply the "Question" label; apply other labels when relevant.
1821

19-
## You think you may have found a bug
22+
You think you may have found a bug
23+
**********************************
2024

21-
1. use the search functionality [here](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues) to see if someone already filed the same issue;
25+
1. use the search functionality `here <https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}/issues>`_ to see if someone already filed the same issue;
2226
1. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
23-
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
27+
- the `SHA hashcode <https://help.github.com/articles/autolinked-references-and-urls/#commit-shas>`_ of the commit that is causing your problem;
2428
- some identifying information (name and version number) for dependencies you're using;
2529
- information about the operating system;
2630
1. apply relevant labels to the newly created issue.
2731

28-
## You want to make some kind of change to the code base
32+
You want to make some kind of change to the code base
33+
*****************************************************
2934

30-
1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
35+
1. (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
3136
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
32-
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
37+
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions `here <https://help.github.com/articles/configuring-a-remote-for-a-fork/>`_ and `here <https://help.github.com/articles/syncing-a-fork/>`_);
3338
1. make sure the existing tests still work by running ``python setup.py test``;
3439
1. add your own tests (if necessary);
3540
1. update or expand the documentation;
36-
1. [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the {{ cookiecutter.project_name }} repository on GitHub;
37-
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
41+
1. `push <http://rogerdudler.github.io/git-guide/>`_ your feature branch to (your fork of) the {{ cookiecutter.project_name }} repository on GitHub;
42+
1. create the pull request, e.g. following the instructions `here <https://help.github.com/articles/creating-a-pull-request/>`_.
3843

3944
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.

0 commit comments

Comments
 (0)