forked from MostlyAdequate/mostly-adequate-guide-id
-
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.
- Loading branch information
Showing
1 changed file
with
35 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,35 @@ | ||
|
||
# Contributing to Mostly Adequate Guide to Functional Programming | ||
|
||
## Licensing | ||
|
||
By opening a pull request to this repository, you agree to provide your work under the [project license](LICENSE.md). Also, you agree to grant such license of your work as is required for the purposes of future print editions to @DrBoolean. Should your changes appear in a printed edition, you'll be included in the contributors list. | ||
|
||
## Small Corrections | ||
|
||
Errata and basic clarifications will be accepted if we agree that they improve the content. You can also open an issue so we can figure out how or if it needs to be addressed. If you've never done this before, the [flow guide](https://guides.github.com/introduction/flow/) might be useful. | ||
|
||
## Questions or Clarifications | ||
|
||
Please, have a look at the [FAQ](FAQ.md) before you open an issue. Your question may already | ||
have been answered. Should you still need to ask something? Feel free to open an issue and to | ||
explain yourself. | ||
|
||
## Translations | ||
|
||
Translations to other languages are highly encouraged. Each official translation will be held as a separate repository in the [MostlyAdequate organization](https://github.com/MostlyAdequate) and linked from the English version book. | ||
Since each translation is a different repository, we can also have different maintainers for each project. | ||
|
||
### Creating a New Translation Repo | ||
|
||
In order to create a new translation, you need to follow these steps: | ||
|
||
* Fork the [main repo](https://github.com/MostlyAdequate/mostly-adequate-guide). | ||
* Add yourself to the watch list of the main repo, to keep up with changes. | ||
* When translating chapters, **create NEW files with suffix of your language**. | ||
* For example, Spanish tranlation for `ch01.md` will be on `ch01-es.md`. | ||
* Open a [new issue](https://github.com/MostlyAdequate/mostly-adequate-guide/issues/new) and ask to be part of the organization. | ||
* Transfer the repo to the organization. | ||
* Merge new content from the main repo. | ||
* keep translating... | ||
* Rinse/repeat last too steps until the book is done. |