aseprite/CONTRIBUTING.md

131 lines
5.8 KiB
Markdown
Raw Normal View History

# Code of Conduct
We have a [code of conduct](CODE_OF_CONDUCT.md) that we all must
follow. Be polite to everyone. If you are not in your best day, take a
deep breath and try again.
# New Issues
Before you submit an issue:
2018-06-17 23:23:55 +00:00
* Search in the current
[list of issues](https://github.com/aseprite/aseprite/issues),
[bug reports](https://community.aseprite.org/c/bugs), or
[feature requests](https://community.aseprite.org/c/features).
* If the issue already exists, add a :+1: or a :heart:, and you can
click the `Subscribe` or `Watching` button to get notifications
via email.
2016-08-04 15:19:31 +00:00
# Compilation problem
2018-06-17 23:23:55 +00:00
Before you submit an issue or a post about a **compilation problem**,
check the following items:
* See how to get the source code correctly in the [INSTALL](INSTALL.md) guide.
* Check if you are using the latest repository clone.
* Remember that we use submodules, so you need to initialize and update them.
* Search in the [GitHub issues about compilation](https://github.com/aseprite/aseprite/issues?q=is%3Aissue+label%3Acompilation)
if someone else had the same problem.
* Remember that might be some [pull requests](https://github.com/aseprite/aseprite/pulls)
being reviewed to fix your same issue.
2018-06-17 23:23:55 +00:00
If you have a compilation problem, you can ask in the
[Development category](https://community.aseprite.org/c/development)
in the [Community site](https://community.aseprite.org/) for help
or create a [new GitHub issue](https://github.com/aseprite/aseprite/issues/new).
2013-11-23 19:01:49 +00:00
# Contributing
One of the easiest ways to contribute is writing articles, [Steam
reviews](https://steamcommunity.com/app/431730/reviews/), blog posts,
recording video tutorials, creating pixel art in social media with
[#aseprite](https://twitter.com/search?q=%23aseprite), or showing your
love to Aseprite, e.g. naming Aseprite in your website and linking it
to https://www.aseprite.org/, following [@aseprite](https://twitter.com/aseprite),
or [buying an extra Aseprite copy to your friends](https://www.aseprite.org/download/).
2013-11-23 19:01:49 +00:00
Other ways to contribute require direct contact with us. For example:
2018-06-17 23:23:55 +00:00
* [Writing documentation](https://github.com/aseprite/docs).
* Making art (and fan art) with Aseprite and for Aseprite (logos, skins, mockups).
2013-11-23 19:01:49 +00:00
* Sending patches for features or bug fixes.
* Reviewing issues in the [issue tracker](https://github.com/aseprite/aseprite/issues)
and making comments.
2018-06-17 23:23:55 +00:00
* Helping other users in the [Community](https://community.aseprite.org/) site.
2013-11-23 19:01:49 +00:00
## Documentation
You can start seeing the
2018-06-17 23:23:55 +00:00
[documentation](https://www.aseprite.org/docs/), and
[contact us](mailto:support@aseprite.org) if you want to help
writing documentation or recording [tutorials](https://www.aseprite.org/docs/tutorial/).
2013-11-23 19:01:49 +00:00
If you are going to write some docs, we recommend you to take
screenshots or record a GIF animations to showcase the feature your
are documenting or the steps to follow:
2013-11-23 19:01:49 +00:00
* As screen recording software, on Windows you can generate GIF files
2014-08-14 03:41:30 +00:00
using [LICEcap](http://www.cockos.com/licecap/).
* PNG/GIF images can be uploaded in the same docs repository
[with a pull request](https://github.com/aseprite/docs/pulls)
2013-11-23 19:01:49 +00:00
## Reviewing Issues
2013-11-23 19:01:49 +00:00
2018-06-17 23:23:55 +00:00
You can [review issues](https://github.com/aseprite/aseprite/issues),
make comments, or create
new [features](https://community.aseprite.org/c/features),
[bug reports](https://community.aseprite.org/c/bugs), etc. You are
encouraged to create mockups for any issue you see and attach them.
2013-11-23 19:01:49 +00:00
## Code submission policy
We have some rules for the changes and commits that are contributed:
* First of all you will need to sign our
[Contributor License Agreement](https://github.com/igarastudio/cla) (CLA)
to submit your code.
* Split your changes in the most atomic commits possible: one commit
for feature, or fix.
* Rebase your commits to the `main` branch (or `beta` if you are
targeting the beta version).
* Wrap your commit messages at 72 characters.
* The first line of the commit message is the subject line.
* Write the subject line in the imperative mood, e.g. "Fix something",
not "Fixed something".
* For platform-specific commits start the subject line using
`[win]`, `[osx]`, or `[x11]` prefixes.
* For CLI related commits you can use the `[cli]` prefix in the
subject line.
* For Lua scripting related commits can use the `[lua]` prefix in
the subject line.
* Check the spelling of your code, comments and commit messages.
* Follow our [coding style guide](docs/CODING_STYLE.md). We're using
some C++17 features, targeting macOS 10.9 mainly as the oldest
platform (and the one limiting us to newer C++ standards),
You can also take a look at the [src/README.md](https://github.com/aseprite/aseprite/tree/main/src/#aseprite-source-code)
guide which contains some information about how the code is structured.
# Community
2018-06-17 23:23:55 +00:00
You can use the [Development category](https://community.aseprite.org/c/development)
to ask questions about the code, how to compile, etc.
If you want to start working on something
2018-06-17 23:23:55 +00:00
([issue](https://github.com/aseprite/aseprite/issues),
[bug](https://community.aseprite.org/c/bugs),
or [feature](https://community.aseprite.org/c/features)),
post a comment asking if somebody is already working on that,
in that way you can avoid starting programming in something that is already
2018-06-17 23:23:55 +00:00
done for the next release or which someone else is working on.
2013-11-23 19:01:49 +00:00
# Future
If you want to contribute a new feature, I highly recommend trying to
contribute a couple of pull requests to fix some bugs first. After
that you can check what are the features we're planning for the
future:
* Our [roadmap](http://www.aseprite.org/roadmap/) and our [planning](https://github.com/orgs/aseprite/projects/10).
* The most liked [issues on GitHub](https://github.com/aseprite/aseprite/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).
* [Features on the forum](https://community.aseprite.org/c/features/7/l/latest?order=votes) with the most votes.