Skip to content

Commit

Permalink
Convert CONTRIBUTING from reStructuredText to Markdown (#149)
Browse files Browse the repository at this point in the history
* Convert reStructuredText (reST) to Markdown

* Convert reStructuredText (reST) formatting to Markdown

* Convert to copy-paste shell commands

* Include commands for one of the functional test suites
  • Loading branch information
dbeatty10 authored Jun 11, 2023
1 parent c3e6076 commit 50d490a
Showing 1 changed file with 44 additions and 42 deletions.
86 changes: 44 additions & 42 deletions CONTRIBUTING.rst → CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
.. highlight:: shell

============
Contributing
============
# Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------
## Types of Contributions

---

Report Bugs
~~~~~~~~~~~
### Report Bugs

Report bugs at https://github.com/dbeatty10/dbt-mysql/issues.

Expand All @@ -23,27 +19,23 @@ If you are reporting a bug, please include:
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~
### Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~
### Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~
### Write Documentation

dbt-mysql could always use more documentation, whether as part of the
official dbt-mysql docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~
### Submit Feedback

The best way to send feedback is to file an issue at https://github.com/dbeatty10/dbt-mysql/issues.

Expand All @@ -54,41 +46,51 @@ If you are proposing a feature:
* Remember that this is a volunteer-driven project and contributions are
welcome :)

Get Started!
------------

Ready to contribute? `Here's <https://jarv.is/notes/how-to-pull-request-fork-github/>`_ how to set up `dbt-mysql` for local development.

1. Fork the `dbt-mysql` repo on GitHub.
2. Clone your fork locally::

$ git clone [email protected]:your_name_here/dbt-mysql.git
## Get Started!

3. Installation::
---

$ python3 -m venv env
$ source env/bin/activate
$ python3 -m pip install --upgrade pip
$ python3 -m pip install -r requirements-dev.txt -r requirements-editable.txt
$ pre-commit install
$ source env/bin/activate
Ready to contribute? [Here's](https://jarv.is/notes/how-to-pull-request-fork-github/) how to set up `dbt-mysql` for local development.

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature
1. Fork the `dbt-mysql` repo on GitHub.
2. Clone your fork locally:
```shell
git clone [email protected]:your_name_here/dbt-mysql.git
```

3. Installation:
```shell
python3 -m venv env
source env/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements-dev.txt -r requirements-editable.txt
pre-commit install
source env/bin/activate
```

4. Create a branch for local development:

```shell
git checkout -b name-of-your-bugfix-or-feature
```

Now you can make your changes locally.

5. Run tests::
5. Run tests:

$ python -m pytest -v tests/unit
```shell
python -m pytest -v tests/unit
python -m pytest -v --profile mysql tests/functional
```

Instructions for running integration tests in `tests/README.md`.

6. Commit your changes and push your branch to GitHub::
6. Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
```shell
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
```

7. Submit a pull request through the GitHub website.

0 comments on commit 50d490a

Please sign in to comment.