Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING #1154

Merged
merged 3 commits into from
Apr 26, 2023
Merged

Update CONTRIBUTING #1154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
541055d
Update CONTRIBUTING
martincostello Apr 26, 2023
b7bc002
Fix typo
martincostello Apr 26, 2023
2632619
Apply suggestions from code review
martincostello Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,38 @@
# Contributing to JustSaying
# Contributing to JustSaying

♥ JustSaying and want to get involved?
:heart: JustSaying and want to get involved?
Great! There are plenty of ways you can help!

If you find a bug, have a feature request or even want to contribute an enhancement or fix, please follow the below guidelines so that we can help you out and/or get your code merged quickly.

## If you find what looks like a bug:

* Check the [GitHub issue tracker](http://github.com/justeattakeaway/JustSaying/issues/ "JustSaying issues") to see if anyone else has reported the issue.
* Make sure you are using the latest version of JustSaying
* If you are still having an issue, create an issue including:
* Information you will need to reproduce and diagnose the problem
* Check the [GitHub issue tracker](http://github.com/justeattakeaway/JustSaying/issues/ "JustSaying issues") to see if anyone else has reported the same issue.
* Make sure you are using the latest version of JustSaying
* If you are still having problems then [create an issue](https://github.com/justeattakeaway/JustSaying/issues/new/choose) with enough information so that it can be reproduced and diagnosed

## If you want to contribute an enhancement or a fix:

1. Discuss any major enhancement with the project moderator.
1. Write your Spec and/or Functional tests.
1. Write or modify any accompanying documentation.
1. Ensure that your tests work and your documentation is complete.
1. Discuss any major enhancement with the project maintainers by creating either an [issue](https://github.com/justeattakeaway/JustSaying/issues/new/choose) or a [discussion](https://github.com/justeattakeaway/JustSaying/discussions).
1. Work on your changes and add any relevant unit and/or functional tests.
1. Write or modify any relevant documentation.
1. Ensure that code builds, the tests pass and your documentation is complete.

## General Contribution Guidelines

### General Contribution Guidelines:
We follow the standard GitHub fork & pull request approach to open source collaboration.
You can find an awesome description on how this works on the [gun.io blog](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/ "How to GitHub: Fork, Branch, Track, Squash and Pull Request").

In a nutshell:

1. Fork JustSaying to your own GitHub account.
1. Create your feature branch (`git checkout -b feature/my-new-feature`).
1. Commit your changes (`git commit -am 'Add some feature'`) and [reference any issues](https://github.com/blog/831-issues-2-0-the-next-generation "Issues 2.0: The Next Generation").
1. Push to your branch (`git push origin my-new-feature`).
1. Send a new Pull Request describing what you have done and why, in detail.

**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the the terms of the Apache 2.0 license. A copy of this
license is provided in the root of the repository.
1. Fork JustSaying to your own GitHub account.
1. Create your feature branch (`git checkout -b feature/my-new-feature`).
1. Commit your changes (`git commit -am 'Add some feature'`) and [reference any issues](https://github.com/blog/831-issues-2-0-the-next-generation "Issues 2.0: The Next Generation").
1. Push to your branch (`git push origin my-new-feature`).
1. Send a new Pull Request describing what you have done and why, in detail.

> **Note**
>
> By submitting a patch, you agree to allow the project owners to license your work under the the terms of the Apache 2.0 license.
>
> A copy of this license is provided in the [root of the repository](https://github.com/justeattakeaway/JustSaying/blob/main/LICENSE).