Skip to content

Commit dd49933

Browse files
1 parent 6a45641 commit dd49933

16 files changed

+297
-375
lines changed

.github/CONTRIBUTING.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Contributing to `react-admin`
2+
3+
Love react-admin and want to help? Thanks so much, there's something to do for everybody!
4+
5+
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
6+
7+
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.
8+
9+
## Using the issue tracker
10+
11+
The [issue tracker](https://github.com/bootstrap-styled/react-admin/issues) is
12+
the preferred channel for [bug reports](#bugs), [features requests](#features)
13+
and [submitting pull requests](#pull-requests).
14+
15+
<a name="bugs"></a>
16+
## Bug reports
17+
18+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
19+
Good bug reports are extremely helpful - thank you!
20+
21+
Guidelines for bug reports:
22+
23+
1. **Use the GitHub issue search** &mdash; check if the issue has already been reported.
24+
25+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or development branch in the repository.
26+
27+
3. **Isolate the problem** &mdash; ideally create a reduced test case and a live example.
28+
29+
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. What is your environment? What steps will reproduce the issue? What browser(s) and OS
30+
experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
31+
32+
Example:
33+
34+
> Short and descriptive example bug report title
35+
>
36+
> A summary of the issue and the browser/OS environment in which it occurs. If
37+
> suitable, include the steps required to reproduce the bug.
38+
>
39+
> 1. This is the first step
40+
> 2. This is the second step
41+
> 3. Further steps, etc.
42+
>
43+
> `<url>` - a link to the reduced test case
44+
>
45+
> Any other information you want to share that is relevant to the issue being
46+
> reported. This might include the lines of code that you have identified as
47+
> causing the bug, and potential solutions (and your opinions on their
48+
> merits).
49+
50+
51+
<a name="features"></a>
52+
## Feature requests
53+
54+
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 project's developers of the merits of this feature. Please provide as much detail and context as possible.
55+
56+
57+
<a name="pull-requests"></a>
58+
## Pull requests
59+
60+
Good pull requests - patches, improvements, new features - are a fantastic
61+
help. They should remain focused in scope and avoid containing unrelated
62+
commits.
63+
64+
**Please ask first** before embarking on any significant pull request (e.g.
65+
implementing features, refactoring code, porting to a different language),
66+
otherwise you risk spending a lot of time working on something that the
67+
project's developers might not want to merge into the project.
68+
69+
Please adhere to the coding conventions used throughout a project (indentation,
70+
accurate comments, etc.) and any other requirements (such as test coverage).
71+
72+
Since the `master` branch is what people actually use in production, we have a
73+
`dev` branch that unstable changes get merged into first. Only when we
74+
consider that stable we merge it into the `master` branch and release the
75+
changes for real.
76+
77+
Adhering to the following process is the best way to get your work
78+
included in the project:
79+
80+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, and configure the remotes:
81+
82+
```bash
83+
# Clone your fork of the repo into the current directory
84+
git clone https://github.com/<your-username>/react-admin.git
85+
# Navigate to the newly cloned directory
86+
cd react-admin
87+
# Assign the original repo to a remote called "upstream"
88+
git remote add upstream https://github.com/kopax/react-admin.git
89+
```
90+
91+
2. If you cloned a while ago, get the latest changes from upstream:
92+
93+
```bash
94+
git checkout dev
95+
git pull upstream dev
96+
```
97+
98+
3. Create a new topic branch (off the `dev` branch) to contain your feature, change, or fix:
99+
100+
```bash
101+
git checkout -b <topic-branch-name>
102+
```
103+
104+
4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/about-git-rebase/) feature to tidy up your commits before making them public.
105+
106+
5. Locally merge (or rebase) the upstream dev branch into your topic branch:
107+
108+
```bash
109+
git pull [--rebase] upstream dev
110+
```
111+
112+
6. Push your topic branch up to your fork:
113+
114+
```bash
115+
git push origin <topic-branch-name>
116+
```
117+
118+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
119+
with a clear title and description.
120+
121+
**IMPORTANT**: By submitting a patch, you agree to allow the project
122+
owners to license your work under the terms of the [MIT License](https://github.com/bootstrap-styled/react-admin/blob/master/LICENSE.md).

.github/ISSUE_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# react-admin
2+
3+
Before opening a new issue, please take a moment to review our [**community guidelines**](https://github.com/bootstrap-styled/react-admin/blob/master/.github/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.
4+
5+
**Before opening a new issue, you may find an answer in already closed issues**:
6+
https://github.com/bootstrap-styled/react-admin/issues?q=is%3Aissue+is%3Aclosed
7+
8+
## Issue Type
9+
10+
- [ ] [Bug](https://github.com/bootstrap-styled/react-admin/blob/master/.github/CONTRIBUTING.md#bug-reports)
11+
- [ ] [Feature](https://github.com/bootstrap-styled/react-admin/blob/master/.github/CONTRIBUTING.md#feature-requests)
12+
13+
## Description
14+
15+
(Add images if possible)
16+
17+
## Steps to reproduce
18+
19+
(Add link to a demo on https://jsfiddle.net or similar if possible)
20+
21+
# Versions
22+
23+
- Node/NPM:
24+
- OS:
25+
- react-admin:
26+
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# Contributing
1+
## react-admin
22

3-
When contributing to this repository, please first discuss the change you wish to make via issue,
4-
email, or any other method with the owners of this repository before making a change.
3+
Thank you for contributing! Please take a moment to review our [**contributing guidelines**](https://github.com/bootstrap-styled/react-admin/blob/master/.github/CONTRIBUTING.md)
4+
to make the process easy and effective for everyone involved.
55

66
**Please open an issue** before embarking on any significant pull request, especially those that
77
add a new library or change existing tests, otherwise you risk spending a lot of time working
8-
on something that might not end up being merged into the project.
9-
10-
Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
11-
12-
## Pull Request Process
8+
on something that might not end up being merged into the project.
139

1410
Before opening a pull request, please ensure:
1511

12+
- [ ] You have followed our [**contributing guidelines**](https://github.com/bootstrap-styled/react-admin/blob/master/.github/CONTRIBUTING.md)
1613
- [ ] Double-check your branch is based on `dev` and targets `dev`
1714
- [ ] Your are doing semantic commit message using [commitizen](https://github.com/commitizen/cz-cli) and our [commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
1815
- [ ] Pull request has tests (we are going for 100% coverage!)
1916
- [ ] Code is well-commented, linted and follows project conventions
2017
- [ ] Documentation is updated (if necessary)
2118
- [ ] Description explains the issue/use-case resolved and auto-closes related issues
2219

23-
Be kind to code reviewers, please try to keep pull requests as small and focused as possible :
20+
Be kind to code reviewers, please try to keep pull requests as small and focused as possible :)
21+
22+
**IMPORTANT**: By submitting a patch, you agree to allow the project
23+
owners to license your work under the terms of the [MIT License](https://github.com/bootstrap-styled/react-admin/blob/master/LICENSE.md).

.github/lock.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Configuration for lock-threads - https://github.com/dessant/lock-threads
2+
3+
# Number of days of inactivity before a closed issue or pull request is locked
4+
daysUntilLock: 365
5+
6+
# Skip issues and pull requests created before a given timestamp. Timestamp must
7+
# follow ISO 8601 (`YYYY-MM-DD`). Set to `false` to disable
8+
skipCreatedBefore: false
9+
10+
# Issues and pull requests with these labels will not be locked. Set to `[]` to disable
11+
exemptLabels: []
12+
13+
# Label to add before locking, such as `outdated`. Set to `false` to disable
14+
lockLabel: false
15+
16+
# Comment to post before locking. Set to `false` to disable
17+
lockComment: >
18+
This thread has been automatically locked since there has not been
19+
any recent activity after it was closed. Please open a new issue for
20+
related bugs.
21+
22+
# Assign `resolved` as the reason for locking. Set to `false` to disable
23+
setLockReason: true
24+
25+
# Limit to only `issues` or `pulls`
26+
# only: issues
27+
28+
# Optionally, specify configuration settings just for `issues` or `pulls`
29+
# issues:
30+
# exemptLabels:
31+
# - help-wanted
32+
# lockLabel: outdated
33+
34+
# pulls:
35+
# daysUntilLock: 30
36+
37+
# Repository to extend settings from
38+
# _extends: repo

.gitlab-ci.yml

Lines changed: 0 additions & 73 deletions
This file was deleted.

.gitlab/issue_templates/Bug.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

.gitlab/issue_templates/Documentation.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)