Skip to content

Commit

Permalink
[bot] synced local 'CONTRIBUTING.md' with remote 'sources/templates/C…
Browse files Browse the repository at this point in the history
…ONTRIBUTING.md'

Sourced from: https://github.com/Wall-Brew-Co/rebroadcast
  • Loading branch information
WallBrewBot committed Jul 20, 2024
1 parent 9dda641 commit f1324ec
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Wall Brew strives to make contributions as simple as possible while ensuring our

- [Code of Conduct](#code-of-conduct)
- [Our Pledge](#our-pledge)
- [Communicating Changes](#communicating-changes)
- [Read the Documentation](#read-the-documentation)
- [Prior to Contributing](#prior-to-contributing)
- [Communicating and Contributing Changes](#communicating-and-contributing-changes)
- [Where To Start](#where-to-start)
- [Pull Request](#pull-request)
- [Restricted Files](#restricted-files)
Expand Down Expand Up @@ -36,7 +36,13 @@ size, disability, ethnicity, gender identity and expression, level of experience

A full copy of our code of conduct may be found in any Wall Brew repository.

## Communicating Changes
## Prior to Contributing

Familiarize yourself with the documentation before you submit a Pull Request.
If you have questions which aren't in the documentation, open a ticket or submit a Pull Request to update the documentation.
Prior to starting development on an individual fork, we recommend executing the tests locally to confirm the library and your machine are working as expected.

## Communicating and Contributing Changes

For small issues, improvements, and bug fixes, feel free to fork any repository and publish a pull request.
A Wall Brew maintainer will be automatically assigned for review, and help you understand any remaining steps to merge your changes.
Expand All @@ -52,22 +58,17 @@ For issues, reports, and changes that span multiple repositories or would change
Lastly, to effectively communicate changes to our consumers, please follow the conventions of each repository when writing documentation or adding annotative metadata to functionality.
This allows us to cleanly and consistently provide our end-users with a high-quality development experience.

### Read the Documentation

Familiarize yourself with the documentation before you submit a Pull Request.
If you have questions which aren't in the documentation, open a ticket or submit a Pull Request to update the documentation.

### Where To Start

If you're looking for ways to contribute, but don't know where to start, try adding additional tests.
Additionally improving documentation or adding examples as you learn a new project can is an easy way to pitch in.
Finally, check the open [issues and feature requests](https://github.com/nnichols/clj-xml/issues) of the project and ask the maintainers if they are available to be taken on.
Finally, check the open [issues and feature requests](https://github.com/Wall-Brew-Co/clj-xml/issues) of the project and ask the maintainers if they are available to be taken on.

## Pull Request

1. Each Wall Brew library follows [SemVer](http://semver.org/ "The Semantic Versioning Scheme"). Please update the version number of any affected projects accordingly.
2. Update the project's [CHANGELOG.md](https://github.com/nnichols/clj-xml/blob/master/CHANGELOG.md) with the new version, date of changes, and a description of the modifications made
3. If any changes impact the external interface or use of the library, please update the [README](https://github.com/nnichols/clj-xml/blob/master/README.md) to reflect any relevant differences or with additional documentation.
2. Update the project's [CHANGELOG.md](https://github.com/Wall-Brew-Co/clj-xml/blob/master/CHANGELOG.md) with the new version, date of changes, and a description of the modifications made with [sealog](https://github.com/Wall-Brew-Co/lein-sealog)
3. If any changes impact the external interface or use of the library, please update the [README](https://github.com/Wall-Brew-Co/clj-xml/blob/master/README.md) to reflect any relevant differences or with additional documentation.
4. Be sure to write and update tests that reflect your changes, with good assertion descriptions, and that ensure future contributions will not cause your changes to regress in behavior.
5. Ensure all automated checks pass against your pull request, and make any updates to fix tests, linter warnings, etc.
6. A Wall Brew maintainer will be automatically assigned to review your Pull Request. Please consider any changes or enhancements they may suggest. In some cases, at the discretion of individual Wall Brew maintainers, these changes may be pushed onto your branch or added to any pull request.
Expand Down

0 comments on commit f1324ec

Please sign in to comment.