Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
chenpangpang
transformers
Commits
45de313a
Commit
45de313a
authored
Oct 08, 2019
by
Rémi Louf
Browse files
add bullet point on modifying an existing PR
parent
ade05b6c
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
24 deletions
+30
-24
CONTRIBUTING.md
CONTRIBUTING.md
+30
-24
No files found.
CONTRIBUTING.md
View file @
45de313a
# How to contribute to transformers?
# How to contribute to transformers?
Everyone is welcome to contribute, and we value everybody's contribution. Code
Everyone is welcome to contribute, and we value everybody's contribution. Code
is thus not the only way to
contribute
. Answering questions, helping
others,
is thus not the only way to
help the community
. Answering questions, helping
reaching out and improving the documentations are immensely valuable to
the
others,
reaching out and improving the documentations are immensely valuable to
community.
the
community.
It also helps us if you spread the word: reference the library from blog posts
It also helps us if you spread the word: reference the library from blog posts
on the awesome projects it made possible, shout out on
t
witter every time it has
on the awesome projects it made possible, shout out on
T
witter every time it has
helped you, or simply star the repo to say "thank you".
helped you, or simply star the repo to say "thank you".
## You can contribute in so many ways!
## You can contribute in so many ways!
...
@@ -14,7 +14,7 @@ helped you, or simply star the repo to say "thank you".
...
@@ -14,7 +14,7 @@ helped you, or simply star the repo to say "thank you".
There are 4 ways you can contribute to transformers:
There are 4 ways you can contribute to transformers:
*
Fixing outstanding issues with the existing code;
*
Fixing outstanding issues with the existing code;
*
Implementing new models;
*
Implementing new models;
*
Contributing to the examples
,
or to the documentation;
*
Contributing to the examples or to the documentation;
*
Submitting issues related to bugs or desired new features.
*
Submitting issues related to bugs or desired new features.
*All are equally valuable to the community.*
*All are equally valuable to the community.*
...
@@ -28,18 +28,17 @@ feedback.
...
@@ -28,18 +28,17 @@ feedback.
### Did you find a bug?
### Did you find a bug?
The transformers are robust and reliable thanks to the users who notify us of
The transformers are robust and reliable thanks to the users who notify us of
the problems they encounter.
the problems they encounter.
So thank you for reporting an issue.
So thank you for reporting an issue. First, we would really appreciate it if you
First, we would really appreciate it if you could
**
make sure the bug was not
could
**make sure the bug was not already reported**
(use the search bar on
already reported
**
(use the search bar on Github under Issues).
Github under Issues).
Did not find it? :( So we can act quickly on it, please follow these steps:
Did not find it? :( So we can act quickly on it, please follow these steps:
*
Include your
**OS type and version**
, the versions of
**Python**
,
**PyTorch**
and
*
Include your
**OS type and version**
, the versions of
**Python**
,
**PyTorch**
and
**Tensorflow**
when applicable;
**Tensorflow**
when applicable;
*
A short, self-contained, code snippet that allows us to reproduce the bug in
*
A short, self-contained, code snippet that allows us to reproduce the bug in
less than 30s
.
less than 30s
;
*
Provide the
*full*
traceback if an exception is raised.
*
Provide the
*full*
traceback if an exception is raised.
To get the OS and software versions, execute the following code and copy-paste
To get the OS and software versions, execute the following code and copy-paste
...
@@ -54,13 +53,14 @@ import tensorflow; print("Tensorflow", tensorflow.__version__)
...
@@ -54,13 +53,14 @@ import tensorflow; print("Tensorflow", tensorflow.__version__)
### Do you want to implement a new model?
### Do you want to implement a new model?
Please provide the following:
Awesome!
Please provide the following
information
:
*
Short description of the model and link to the paper
*
Short description of the model and link to the paper
;
*
Link to the implementation if open-source
*
Link to the implementation if
it is
open-source
;
*
Link to the model weights if they are available
*
Link to the model weights if they are available
.
Let us know if you are willing to contribute so we can best guide you.
If you are willing to contribute the model yourself, let us know so we can best
guide you.
### Do you want a new feature (that is not a model)?
### Do you want a new feature (that is not a model)?
...
@@ -73,19 +73,19 @@ A world-class feature request addresses the following points:
...
@@ -73,19 +73,19 @@ A world-class feature request addresses the following points:
about it!
about it!
*
Is it something you worked on and think could benefit the community?
*
Is it something you worked on and think could benefit the community?
Awesome! Tell us what problem it solved for you.
Awesome! Tell us what problem it solved for you.
2.
Write a
*full paragraph*
describing the feature
.
2.
Write a
*full paragraph*
describing the feature
;
3.
Provide a
**code snippet**
that demonstrates its future use
.
3.
Provide a
**code snippet**
that demonstrates its future use
;
4.
In case this is related to a paper, please
provide
a link
4.
In case this is related to a paper, please
attach
a link
;
5.
Attach any additional information (drawings, screenshots, etc.) you think may help.
5.
Attach any additional information (drawings, screenshots, etc.) you think may help.
If your issue is well
-
written we're already 80% of the way there by the time you
If your issue is well
written we're already 80% of the way there by the time you
post it.
post it.
## Start contributing! (Pull Requests)
## Start contributing! (Pull Requests)
Before writing code, we strongly advise you to search through the exising PRs or
Before writing code, we strongly advise you to search through the exising PRs or
issues to make sure that nobody is already working on the same thing. I
t is
issues to make sure that nobody is already working on the same thing. I
f you are
always a good idea to open an issue to get some feedback.
unsure, it is
always a good idea to open an issue to get some feedback.
You will need basic
`git`
proficiency to be able to contribute to
You will need basic
`git`
proficiency to be able to contribute to
`transformers`
.
`git`
is not the easiest tool to use but it has the greatest
`transformers`
.
`git`
is not the easiest tool to use but it has the greatest
...
@@ -95,7 +95,7 @@ Git](https://git-scm.com/book/en/v2) is a very good reference.
...
@@ -95,7 +95,7 @@ Git](https://git-scm.com/book/en/v2) is a very good reference.
Follow these steps to start contributing:
Follow these steps to start contributing:
1.
Fork the
[
repository
](
https://github.com/huggingface/transformers
)
by
1.
Fork the
[
repository
](
https://github.com/huggingface/transformers
)
by
clicking on the 'Fork' button. This creates a copy of the code
clicking on the 'Fork' button
on the repository's page
. This creates a copy of the code
under your github user account.
under your github user account.
2.
Clone your fork to your local disk, and add the base repository as a remote:
2.
Clone your fork to your local disk, and add the base repository as a remote:
...
@@ -113,7 +113,7 @@ Follow these steps to start contributing:
...
@@ -113,7 +113,7 @@ Follow these steps to start contributing:
**do not**
work on the
`master`
branch.
**do not**
work on the
`master`
branch.
4.
Set up a development environment by running in a virtual environment:
4.
Set up a development environment by running
the following command
in a virtual environment:
```
bash
```
bash
$
pip
install
-r
requirements-dev.txt
$
pip
install
-r
requirements-dev.txt
...
@@ -146,13 +146,19 @@ Follow these steps to start contributing:
...
@@ -146,13 +146,19 @@ Follow these steps to start contributing:
6.
Once you are satisfied (
**and the checklist below is happy too**
), go to the
6.
Once you are satisfied (
**and the checklist below is happy too**
), go to the
webpage of your fork on Github. Click on 'Pull request' to send your changes
webpage of your fork on Github. Click on 'Pull request' to send your changes
to the project maintainers for review.
to the project maintainers for review.
7.
It's ok if maintainers ask you for changes. It happens to core contributors
too! So everyone can see the changes in the Pull request, work in your local
branch and push the changes to your fork. They will automatically appear in
the pull request.
### Checklist
### Checklist
1.
The title of your pull request should be a summary of its contribution;
1.
The title of your pull request should be a summary of its contribution;
2.
If your pull request adresses an issue, please mention the issue number in
2.
If your pull request adresses an issue, please mention the issue number in
the pull request description to make sure they are linked;
the pull request description to make sure they are linked (and people
consulting the issue know you are working on it);
3.
To indicate a work in progress please prefix the title with
`[WIP]`
. These
3.
To indicate a work in progress please prefix the title with
`[WIP]`
. These
are useful to avoid duplicated work, and to differentiate it from PRs ready
are useful to avoid duplicated work, and to differentiate it from PRs ready
to be merged;
to be merged;
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment