forked from openaire/guidelines
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Contribution guide and frontpage update
* Adds contribution guide. (closes openaire#5) * Removes "guidelines in practice" section. (addresses openaire#20) * Revises front page. (addresses openaire#17) * Removes reference to old wiki page. (closes openaire#12)
- Loading branch information
Showing
15 changed files
with
166 additions
and
34 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 |
---|---|---|
@@ -1,17 +1,59 @@ | ||
Contributing | ||
============ | ||
|
||
Initial stub for contribution guidelines. | ||
|
||
* Create a GitHub account | ||
* Ask a question | ||
* Editing the text via GitHub. | ||
* ReStructuredText syntax and cheat sheet. | ||
* Submitting a pull request. | ||
- commit message | ||
- purpose | ||
* Discussing the pull request. | ||
- updating the pull request. | ||
- emoji | ||
- notification @mention | ||
*Merging the pull request. | ||
The OpenAIRE guidelines can be viewed online on http://guidelines.openaire.eu. | ||
|
||
Create a GitHub account | ||
----------------------- | ||
You will need a GitHub account to contribute to the OpenAIRE guidelines. It is | ||
free an easy - just go to https://github.com/join and follow the instructions. | ||
|
||
Once you've got your GitHub account, ahead on over to the OpenAIRE Guidelines | ||
on GitHub https://github.com/openaire/guidelines | ||
|
||
.. image:: images/join.png | ||
:scale: 50% | ||
:align: center | ||
|
||
Participate in the discussion | ||
----------------------------- | ||
* Want to participate in our discussion? Join the ongoing conversation on | ||
our list of issues: https://github.com/openaire/guidelines/issues | ||
|
||
* Have a question, feedback or problem? Simply go open a new | ||
issue on our GitHub repository: | ||
https://github.com/openaire/guidelines/issues/new. | ||
|
||
You can also get to the "New issue" from the frontpage of our GitHub | ||
repository: | ||
|
||
.. image:: images/issues.png | ||
:align: center | ||
:scale: 100% | ||
|
||
**Styles** | ||
|
||
The description of issues can be styled using a syntax called Markdown. See | ||
more on how to create headings, bold and bullets on | ||
https://guides.github.com/features/mastering-markdown/. You can even include | ||
images in the text, simply by dragging and dropping the image onto the | ||
issue description text area. | ||
|
||
Editing the guidelines | ||
---------------------- | ||
Found a typo or want to revise major parts of the guidelines? Editing the | ||
guidelines can be done directly on GitHub. If this is the first time you | ||
are using GitHub, follow our guide here: :ref:`contrib_editing` | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
contrib_editing | ||
|
||
|
||
Get notified | ||
------------ | ||
Afraid you missed an update? GitHub allows you to easily keep updated with the | ||
latest changes using their notifications: | ||
|
||
* https://github.com/openaire/guidelines/notifications |
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
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 |
---|---|---|
@@ -0,0 +1,76 @@ | ||
.. _contrib_editing: | ||
|
||
Editing the guidelines | ||
---------------------- | ||
Found a typo or want to revise major parts of the guidelines? Editing the | ||
guidelines can be done directly on GitHub. | ||
|
||
1. Go to http://guidelines.openaire.eu and find the page you want to edit. | ||
|
||
2. Click "Edit on GitHub" in the top right corner. This will take you directly | ||
to the source file on GitHub. | ||
|
||
.. image:: images/editongithub.png | ||
:align: center | ||
:scale: 100% | ||
|
||
3. Click the edit icon. If it's grayed out, it's likely because you are not | ||
signed into your GitHub account. | ||
|
||
.. image:: images/editicon.png | ||
:align: center | ||
:scale: 100% | ||
|
||
4. Edit the file. Note that the editor supports full-screen mode and allows you | ||
to preview your changes. | ||
|
||
.. image:: images/editfile.png | ||
:align: center | ||
:scale: 100% | ||
|
||
5. Once your done editing the file, write a small commit message to | ||
propose the file change and finally click "Propose file change". This will | ||
allow you to create what is called a "pull request". See next section. | ||
|
||
|
||
Submitting a pull request | ||
------------------------- | ||
|
||
1. After clicking "Propose file change", you can review your changes compared | ||
against the latest master version. If you're happy with the changes, go | ||
a head and click "Create pull request". | ||
|
||
.. image:: images/comparechanges.png | ||
:align: center | ||
:scale: 50% | ||
|
||
2. Enter a title for your pull request and describe the changes made if | ||
necessary and finally click, "Create pull request". | ||
|
||
.. image:: images/openpr.png | ||
:align: center | ||
:scale: 50% | ||
|
||
|
||
Discussing the pull request | ||
--------------------------- | ||
|
||
1. Everyone can see your proposed changes, and the changes can be discussed. | ||
Every pull request is also automatically checked for errors in the | ||
documentation source files by an external service called TravisCI. | ||
|
||
.. image:: images/pr.png | ||
:align: center | ||
:scale: 50% | ||
|
||
|
||
2. The tab "Files changed", others can see the changes to the files, and | ||
comment on individual lines as well. | ||
|
||
|
||
Merging the pull request | ||
------------------------ | ||
|
||
Once the changes have been approved, one of the editors will merge the changes | ||
into the master version. After the merge, the changes are automatically | ||
propagated to online version on http://guidelines.openaire.eu. |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.. _contributing: | ||
|
||
.. include:: ../CONTRIBUTING.rst |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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