Skip to content

Commit

Permalink
Update contributing docs (#612)
Browse files Browse the repository at this point in the history
  • Loading branch information
sloria authored Aug 14, 2024
1 parent 5e04d89 commit fb424df
Showing 1 changed file with 1 addition and 14 deletions.
15 changes: 1 addition & 14 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,6 @@ Setting Up for Local Development
# The pre-commit CLI was installed above
$ pre-commit install --allow-missing-config

Git Branch Structure
--------------------

marshmallow-sqlalchemy abides by the following branching model:

``dev``
Current development branch. **New features should branch off here**.

``X.Y-line``
Maintenance branch for release ``X.Y``. **Bug fixes should be sent to the most recent release branch.**. The maintainer will forward-port the fix to ``dev``. Note: exceptions may be made for bug fixes that introduce large code changes.

**Always make a new branch for your work**, no matter how small. Also, **do not put unrelated changes in the same branch or pull request**. This makes it more difficult to merge your changes.

Pull Requests
--------------

Expand All @@ -71,7 +58,7 @@ Pull Requests
- You've added yourself to ``AUTHORS.rst``.

4. Submit a pull request to ``marshmallow-code:dev`` or the appropriate maintenance branch.
The `CI <https://dev.azure.com/sloria/sloria/_build/latest?definitionId=10&branchName=dev>`_ build
The `CI <https://github.com/marshmallow-code/marshmallow-sqlalchemy/actions/workflows/build-release.yml>`_ build
must be passing before your pull request is merged.

Running Tests
Expand Down

0 comments on commit fb424df

Please sign in to comment.