Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing section #859

Merged
merged 2 commits into from
Mar 17, 2021
Merged

Update contributing section #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
839baf8
Update contributing section
ST-DDT Dec 24, 2020
a248051
Fix wording based on comment
ST-DDT Jan 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions source/contributing/guidelines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ General steps
#. Make sure you're familiar with Git and GitHub. If your knowledge needs a refresh, take a look here: :doc:`howtogit`

#. Check for existing issues in the `SpongeAPI <https://github.com/SpongePowered/SpongeAPI/issues>`_,
`SpongeCommon <https://github.com/SpongePowered/SpongeCommon>`_,
`SpongeForge <https://github.com/SpongePowered/SpongeForge>`_,
`SpongeVanilla <https://github.com/SpongePowered/SpongeVanilla>`_, and
`SpongeCommon <https://github.com/SpongePowered/SpongeCommon>`_ and
`SpongeDocs <https://github.com/SpongePowered/SpongeDocs>`_ repositories. There is possibly someone else already
working on the same thing. You can also check
`issues marked with "help wanted" <https://github.com/SpongePowered/SpongeAPI/labels/help%20wanted>`_ for existing
Expand Down
5 changes: 3 additions & 2 deletions source/contributing/implementation/codestyle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ few additions and modifications, which are described herein.

.. tip::
You can use our code styles for Eclipse or IntelliJ IDEA to let your IDE format the code correctly for you. Visit
`Sponge Code Styles <https://github.com/SpongePowered/SpongeAPI/tree/e4abe364d98f6f068018fd96525f88f5fb47a0cf/extra>`_.
`Sponge Code Styles <https://github.com/SpongePowered/SpongeAPI/tree/api-8/extra>`_.

* Line endings

Expand Down Expand Up @@ -72,7 +72,8 @@ Code Conventions
``null`` in the API
* Method parameters accepting ``null`` must be annotated with ``@Nullable`` (from javax.*), all methods and parameters
are ``@Nonnull`` by default.
* Use `Google Preconditions <https://github.com/google/guava/wiki/PreconditionsExplained>`_ for null- and
* API: Use ``java.util.Objects.requireNonNull`` for null checks and ``if``\s for argument checking.
* Impl: Use `Google Preconditions <https://github.com/google/guava/wiki/PreconditionsExplained>`_ for null- and
argument checking.

The Gist
Expand Down
8 changes: 3 additions & 5 deletions source/contributing/implementation/debugging/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ Here are the steps to setup your workspace if you do not have one already:
With these instructions successfully completed, you are ready to import the project into your IDE.

.. note::
This is an outline of the steps necessary to setup the workspace. See the `SpongeForge
<https://github.com/SpongePowered/SpongeForge>`_ or
`SpongeVanilla <https://github.com/SpongePowered/SpongeVanilla>`_ GitHub pages for complete instructions on
cloning, setup, building, and running the implementation.
This is an outline of the steps necessary to setup the workspace. See the `Sponge
<https://github.com/SpongePowered/SpongeCommon>`_ GitHub page for complete instructions on cloning, setup, building,
and running the implementations.

Contents
========
Expand All @@ -51,4 +50,3 @@ Contents
tools
more
faq

2 changes: 1 addition & 1 deletion source/contributing/implementation/pr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ A few things that can be taken from this:

.. code-block:: md

*SpongeAPI* | [SpongeCommon](html link) | [SpongeForge](html link) | [SpongeVanilla](html link)
*SpongeAPI* | [SpongeCommon](html link) | [SpongeDocs](html link)


* Clear description of what the API PR is aiming to do, this can be a brief summary as if writing an essay, at most 4
Expand Down