Skip to content

Commit

Permalink
Merge pull request #282 from LibrePDF/develop
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md
  • Loading branch information
andreasrosdal committed Jul 27, 2019
2 parents 93abf47 + d454d14 commit b98d86a
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions CONTRIBUTING.md
@@ -1,16 +1,27 @@
# Contributing to Freeciv-Web

Thank you for your interest in contributing!
Thank you for your interest in contributing to Freeciv-web!

## Getting Started

The developers of this project can be found in freenode IRC #freeciv-dev
and in this discord [guild](https://discord.gg/X8bKbry), channel #dev. If
you want an idea for a good starting project, poke someone in there first.
Freeciv is an open source project where contributions from the open source community is encouraged.
There are multiple versions of Freeciv-web, and Freeciv-web can be hosted on multiple server instances.
To get involved in one of these Freeciv-web instances, you may either contribute directly to the
github.com/freeciv/freeciv-web repository by submitting a pull-request there, or contact one of the fork projects
of Freeciv-web on GitHub, IRC, e-mailing lists, Discord or similar.

## Multiple Freeciv-web servers
We need to recognize that there are multiple competing Freeciv-web servers, and that the main
freeciv/freeciv-web github repository must be generic and not specific to one site.
We will get a better Freeciv-web service if we allow multiple servers to exists and compete.

## Pull Request Guidelines

- Try not to exceed 200 LOC +- in a single PR.
- All changes to Freeciv-web must be done using Pull Requests on GitHub. Don't commit changes directly to the master or develop branch.
- Pull requests must be approved by two other Freeciv developers. Minor changes can be approved by one Freeciv developer. If there's no objections within 72h to the pull request, it's ok to merge it.
- Don't break the build. All tests run by Travis CI must pass successfully.
- The repository github.com/freeciv/freeciv-web should be generic, not specific to one particular Freeciv-web server instance or Freeciv-web fork.
- Try not to exceed 200 LOC +- in a single PR. Larger pull-requests are allowed when required.
- Avoid whitespace-only or other trivial changes that do not change logic.

The best thing you can do is to keep commits and PRs contextual. Small PRs
Expand Down

0 comments on commit b98d86a

Please sign in to comment.