-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Some formatting changes, and fixing broken links.
- Loading branch information
Showing
1 changed file
with
19 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,9 +10,9 @@ we came up with a few guidelines to help make your experience pleasant and painl | |
|
||
### Reporting Bugs | ||
|
||
Before reporting a bug, please check the [Issues List](https://in.thewardro.be/web/youversion-react-components/issues) to see if it's already been reported. | ||
Before reporting a bug, please check the [Issues List][issues] to see if it's already been reported. | ||
|
||
If you believe you've found an issue that isn't covered in the issues list, please submit a new issue to this project's [Issues List](https://in.thewardro.be/web/youversion-react-components/issues). Here's some guidelines, inspired by the [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#reporting-bugs) project, that can make things easier: | ||
If you believe you've found an issue that isn't covered in the issues list, please submit a new issue to this project's [Issues List][issues]. Here's some guidelines, inspired by the [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#reporting-bugs) project, that can make things easier: | ||
|
||
* Use a clear and descriptive title for the issue to identify the problem. | ||
* Describe the exact steps which reproduce the problem in as many details as possible. | ||
|
@@ -27,24 +27,33 @@ If you believe you've found an issue that isn't covered in the issues list, plea | |
#### Check our issues list. | ||
We don't typically accept pull requests for anything that isn't in our list of issues. If you're looking for a place to get started, dive right on into those issues and find one that tickles your fancy. We have some special issue labels to help you get started: | ||
|
||
* *[First-time Contributor](https://in.thewardro.be/web/youversion-react-components/issues?label_name%5B%5D=first-timers-only)*: These are low-hanging fruit that we believe would be a great place to get your feet wet. We ask that you limit yourself to only one or two of these. We want to leave plenty of easy grabbing on the lower limbs for all the newbies to share. | ||
* *[Good First Issue](https://github.com/lifechurch/melos/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)*: These are low-hanging fruit that we believe would be a great place to get your feet wet. We ask that you limit yourself to only one or two of these. We want to leave plenty of easy grabbing on the lower limbs for all the newbies to share. | ||
|
||
* *[Volunteer](https://in.thewardro.be/groups/web/issues?label_name%5B%5D=Volunteer)*: Issues marked as "Volunteer" are usually well-documented, and ready for a volunteer or contributor to handle without a lot of guidance. | ||
* *[Volunteer](https://github.com/lifechurch/melos/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22volunteer%22%20)*: Issues marked as "Volunteer" are usually well-documented, and ready for a volunteer or contributor to handle without a lot of guidance. | ||
|
||
|
||
#### Contributing Code | ||
|
||
1. Fork or clone this repository | ||
|
||
git clone [email protected]:web/youversion-react-components.git | ||
``` | ||
git clone [email protected]:web/youversion-react-components.git | ||
``` | ||
|
||
2. Install / Setup *(More install details in the [README](/README))* | ||
|
||
npm install | ||
2. Install / Setup *(More install details in the [README](./README))* | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
3. Make sure tests pass before and after your changes, via | ||
|
||
npm run test | ||
``` | ||
npm run test | ||
``` | ||
|
||
4. [Submit a Pull Request](https://help.github.com/articles/creating-a-pull-request/) | ||
|
||
|
||
|
||
4. [Submit a merge request](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html) | ||
[issues]: https://github.com/lifechurch/melos/issues |