6502/millfork
1
0
Fork 0
mirror of https://github.com/KarolS/millfork.git synced 2024-12-29 02:31:45 +00:00
Code Issues Projects Releases Wiki Activity

Add CONTRIBUTING.md

Browse Source
This commit is contained in:
Karol Stasiak 2019-09-18 00:48:33 +02:00
parent c45cf7d51d
commit 239d837f96
3 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,41 @@
# Contributing guidelines
## Contributing directly
At this point, the Millfork project uses Github for maintaining and distributing the project.
If you want to contribute:
* fork the master branch of the Millfork repository on Github;
* in your fork: implement something nice, fix some bugs, or improve documentation;
* make a pull request, explaining what you implemented if needed.
By making pull request, you agree for your changes to be distributed in perpetuity
under the applicable license (GPL-3 for the compiler, zlib for the stdlib, CC0 for documentation)
or any other compatible license.
You retain copyright to your contributions, you do not have to assign the copyright to anybody.
### Most wanted:
* programmers for 8-bit platforms who can add or improve support for their favourite machines.
The supported (to various degrees) machines are [listed here](https://github.com/KarolS/millfork/blob/master/docs/api/target-platforms.md).
The machines that could be supported, but are not yet, are [listed here](https://github.com/KarolS/millfork/issues/1).
* Scala programmers who can help with implementing the 6809 backend
## Contributing indirectly
If you want to help the project in a different way,
here are other ways you can help:
* reporting bugs and other issues: at https://github.com/KarolS/millfork/issues
* making feature requests: also at https://github.com/KarolS/millfork/issues
* giving advice
* benchmarking: feel free to contribute to https://github.com/KarolS/millfork-benchmarks
* simply using Millfork ☺

2
README.md
View File

@ -57,6 +57,8 @@ The compiler is distributed under GPLv3 (see [LICENSE](LICENSE)).
The standard include files (located in the `include` directory) are distributed under a more permissive Zlib license (see [include/LICENSE](include/LICENSE)). The standard include files (located in the `include` directory) are distributed under a more permissive Zlib license (see [include/LICENSE](include/LICENSE)).
Therefore, no attribution is needed if you are developing and distributing Millfork programs. Therefore, no attribution is needed if you are developing and distributing Millfork programs.
The documentation is distributed under the [CC-0 license](https://creativecommons.org/publicdomain/zero/1.0/).
## More info ## More info
* [Documentation](docs/README.md) (external version: [https://millfork.readthedocs.io](https://millfork.readthedocs.io)) * [Documentation](docs/README.md) (external version: [https://millfork.readthedocs.io](https://millfork.readthedocs.io))

2
docs/index.md
View File

@ -33,4 +33,6 @@ Millfork is © by Karol Stasiak, and is released under the GNU Public License ve
Millfork standard include files are © by Karol Stasiak, and are released under the zlib License. Millfork standard include files are © by Karol Stasiak, and are released under the zlib License.
Millfork documentation is realeased under the [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).
This means you are allowed to develop Millfork programs, both free and proprietary, open- and closed-source, without any extra obligations or requirements. This means you are allowed to develop Millfork programs, both free and proprietary, open- and closed-source, without any extra obligations or requirements.