|
1 | | -# Submitting Issues |
2 | | -## Bug Reports |
3 | | - |
4 | | -A bug is a _demonstrable problem_ that is caused by the code in the repository. |
5 | | -Good bug reports are extremely helpful - thank you! |
6 | | - |
7 | | -Guidelines for bug reports: |
8 | | - |
9 | | -1. **Use the GitHub issue search** — Check if the issue has already been |
10 | | - reported. If it already exists, consider leaving a comment with any extra clarifying |
11 | | - details about your situation that might help us narrow in on the nature of the problem. |
12 | | - |
13 | | -2. **Check if the issue has already been fixed** — In the event that you don't |
14 | | - have the latest, try to reproduce it using the latest changes in the `master` branch. |
15 | | - |
16 | | -3. **Submit a clear and detailed issue** — Please try to be as detailed as possible |
17 | | - in your report. Please include the following: |
18 | | - - Your environment, OS and/or browsers facing the issue |
19 | | - - Steps to reproduce the issue |
20 | | - - Specific errors thrown, stack trace etc. |
21 | | - - The behaviour you expect vs what it's doing |
22 | | - |
23 | | - |
24 | | -## Feature Requests |
25 | | - |
26 | | -Feature requests are welcome. But take a moment to find out whether your idea |
27 | | -fits with the scope and aims of the project. It's up to *you* to make a strong |
28 | | -case to convince the project's developers of the merits of this feature. Please |
29 | | -provide as much detail and context as possible. |
30 | | - |
31 | | - |
32 | | -# Contributing Code |
33 | | - |
34 | | -Good pull requests - patches, improvements, new features - are a fantastic |
35 | | -help. They should remain focused in scope and avoid containing unrelated |
36 | | -commits. |
37 | | - |
38 | | -Please adhere to the coding conventions used throughout this monorepo (indentation, |
39 | | -accurate comments, etc.) and any other requirements (such as test coverage). |
40 | | - |
41 | | -Follow this process: |
42 | | - |
43 | | -1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, |
44 | | - and configure the remotes: |
45 | | - |
46 | | - ```bash |
47 | | - # Clone your fork of the repo into the current directory |
48 | | - git clone https://github.com/<your-username>/bitcore |
49 | | - # Navigate to the newly cloned directory |
50 | | - cd bitcore |
51 | | - # Assign the original repo to a remote called "upstream" |
52 | | - git remote add upstream https://github.com/bitpay/bitcore |
53 | | - ``` |
54 | | - |
55 | | -2. If you cloned a while ago, get the latest changes from upstream: |
56 | | - |
57 | | - ```bash |
58 | | - git checkout master |
59 | | - git pull upstream master |
60 | | - ``` |
61 | | - |
62 | | -3. Create a new feature branch (off the `master` branch) to |
63 | | - contain your feature, change, or fix: |
64 | | - |
65 | | - ```bash |
66 | | - git checkout -b <feature-branch-name> |
67 | | - ``` |
68 | | - |
69 | | -4. Write code and commit your changes in logical chunks. |
70 | | - |
71 | | -5. Locally merge (or rebase) the upstream `master` branch into your feature branch: |
72 | | - |
73 | | - ```bash |
74 | | - git pull [--rebase] upstream master |
75 | | - ``` |
76 | | - |
77 | | -6. Push your feature branch up to your fork: |
78 | | - |
79 | | - ```bash |
80 | | - git push origin <feature-branch-name> |
81 | | - ``` |
82 | | - |
83 | | -7. [Open a Merge Request](https://help.github.com/articles/using-pull-requests/) |
84 | | - with a clear title and description from your fork to the base repository (bitpay/bitcore - master). |
85 | | - |
86 | | - |
| 1 | +# Submitting Issues |
| 2 | +## Bug Reports |
| 3 | + |
| 4 | +A bug is a _demonstrable problem_ that is caused by the code in the repository. |
| 5 | +Good bug reports are extremely helpful - thank you! |
| 6 | + |
| 7 | +Guidelines for bug reports: |
| 8 | + |
| 9 | +1. **Use the GitHub issue search** — Check if the issue has already been |
| 10 | + reported. If it already exists, consider leaving a comment with any extra clarifying |
| 11 | + details about your situation that might help us narrow in on the nature of the problem. |
| 12 | + |
| 13 | +2. **Check if the issue has already been fixed** — In the event that you don't |
| 14 | + have the latest, try to reproduce it using the latest changes in the `master` branch. |
| 15 | + |
| 16 | +3. **Submit a clear and detailed issue** — Please try to be as detailed as possible |
| 17 | + in your report. Please include the following: |
| 18 | + - Your environment, OS and/or browsers facing the issue |
| 19 | + - Steps to reproduce the issue |
| 20 | + - Specific errors thrown, stack trace etc. |
| 21 | + - The behaviour you expect vs what it's doing |
| 22 | + |
| 23 | + |
| 24 | +## Feature Requests |
| 25 | + |
| 26 | +Feature requests are welcome. But take a moment to find out whether your idea |
| 27 | +fits with the scope and aims of the project. It's up to *you* to make a strong |
| 28 | +case to convince the project's developers of the merits of this feature. Please |
| 29 | +provide as much detail and context as possible. |
| 30 | + |
| 31 | + |
| 32 | +# Contributing Code |
| 33 | + |
| 34 | +Good pull requests - patches, improvements, new features - are a fantastic |
| 35 | +help. They should remain focused in scope and avoid containing unrelated |
| 36 | +commits. |
| 37 | + |
| 38 | +Please adhere to the coding conventions used throughout this monorepo (indentation, |
| 39 | +accurate comments, etc.) and any other requirements (such as test coverage). |
| 40 | + |
| 41 | +Follow this process: |
| 42 | + |
| 43 | +1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, |
| 44 | + and configure the remotes: |
| 45 | + |
| 46 | + ```bash |
| 47 | + # Clone your fork of the repo into the current directory |
| 48 | + git clone https://github.com/<your-username>/bitcore |
| 49 | + # Navigate to the newly cloned directory |
| 50 | + cd bitcore |
| 51 | + # Assign the original repo to a remote called "upstream" |
| 52 | + git remote add upstream https://github.com/bitpay/bitcore |
| 53 | + ``` |
| 54 | + |
| 55 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 56 | + |
| 57 | + ```bash |
| 58 | + git checkout master |
| 59 | + git pull upstream master |
| 60 | + ``` |
| 61 | + |
| 62 | +3. Create a new feature branch (off the `master` branch) to |
| 63 | + contain your feature, change, or fix: |
| 64 | + |
| 65 | + ```bash |
| 66 | + git checkout -b <feature-branch-name> |
| 67 | + ``` |
| 68 | + |
| 69 | +4. Write code and commit your changes in logical chunks. |
| 70 | + |
| 71 | +5. Locally merge (or rebase) the upstream `master` branch into your feature branch: |
| 72 | + |
| 73 | + ```bash |
| 74 | + git pull [--rebase] upstream master |
| 75 | + ``` |
| 76 | + |
| 77 | +6. Push your feature branch up to your fork: |
| 78 | + |
| 79 | + ```bash |
| 80 | + git push origin <feature-branch-name> |
| 81 | + ``` |
| 82 | + |
| 83 | +7. [Open a Merge Request](https://help.github.com/articles/using-pull-requests/) |
| 84 | + with a clear title and description from your fork to the base repository (bitpay/bitcore - master). |
0 commit comments