Alexey Boroda / uamap_old

Blame view

frontend/themes/defaults/web/bxslider-4/CONTRIBUTING.md 3.95 KB
Edit Raw Normal View History
d1f8bd40   Alexey Boroda   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
  # Contributing to this project
  
  Please take a moment to review this document in order to make the contribution
  process easy and effective for everyone involved.
  
  Following these guidelines helps to communicate that you respect the time of
  the developers managing and developing this open source project. In return,
  they should reciprocate that respect in addressing your issue or assessing
  patches and features.
  
  
  ## Using the issue tracker
  
  The issue tracker is the preferred channel for [bug reports](#bugs),
  [features requests](#features) and [submitting pull
  requests](#pull-requests), but please respect the following restrictions:
  
  * Please **do not** use the issue tracker for personal support requests.
  
  * Please **do not** derail or troll issues. Keep the discussion on topic and
    respect the opinions of others.
  
  
  <a name="bugs"></a>
  ## Bug reports
  
  A bug is a _demonstrable problem_ that is caused by the code in the repository.
  Good bug reports are extremely helpful - thank you!
  
  Guidelines for bug reports:
  
  1. **Use the GitHub issue search** &mdash; check if the issue has already been
     reported.
  
  2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
     latest `master` or development branch in the repository.
  
  3. **Isolate the problem** &mdash; make sure that the code in the repository is
  _definitely_ responsible for the issue.
  
  A good bug report shouldn't leave others needing to chase you up for more
  information. Please try to be as detailed as possible in your report. Examples are
  important, please try to provide them.
  
  
  <a name="features"></a>
  ## Feature requests
  
  Feature requests are welcome. But take a moment to find out whether your idea
  fits with the scope and aims of the project. It's up to *you* to make a strong
  case to convince the developers of the merits of this feature. Please
  provide as much detail and context as possible.
  
  
  <a name="pull-requests"></a>
  ## Pull requests
  
  Good pull requests - patches, improvements, new features - are a fantastic
  help. They should remain focused in scope and avoid containing unrelated
  commits.
  
  **Please ask first** before embarking on any significant pull request (e.g.
  implementing features, refactoring code), otherwise you risk spending a lot of
  time working on something that the developers might not want to merge into the
  project.
  
  Please adhere to the coding conventions used throughout the project (indentation,
  comments, etc.).
  
  Adhering to the following this process is the best way to get your work
  merged:
  
  1. [Fork](http://help.github.com/fork-a-repo/) the repo, clone your fork,
     and configure the remotes:
  
     ```bash
     # Clone your fork of the repo into the current directory
     git clone https://github.com/<your-username>/<repo-name>
     # Navigate to the newly cloned directory
     cd <repo-name>
     # Assign the original repo to a remote called "upstream"
     git remote add upstream https://github.com/<upsteam-owner>/<repo-name>
     ```
  
  2. If you cloned a while ago, get the latest changes from upstream:
  
     ```bash
     git checkout <dev-branch>
     git pull upstream <dev-branch>
     ```
  
  3. Create a new topic branch (off the main project development branch) to
     contain your feature, change, or fix:
  
     ```bash
     git checkout -b <topic-branch-name>
     ```
  
  4. Commit your changes in logical chunks. Please adhere to these [git commit
     message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
     or your code is unlikely be merged into the main project. Use Git's
     [interactive rebase](https://help.github.com/articles/interactive-rebase)
     feature to tidy up your commits before making them public.
  
  5. Locally merge (or rebase) the upstream development branch into your topic branch:
  
     ```bash
     git pull [--rebase] upstream <dev-branch>
     ```
  
  6. Push your topic branch up to your fork:
  
     ```bash
     git push origin <topic-branch-name>
     ```
  
  10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
      with a clear title and description.