mirror of
https://github.com/aseprite/aseprite.git
synced 2024-09-04 05:59:22 +00:00
Fixes https://aseprite/sourcecode/issues/83, moving the CLA process to https://github.com/igarastudio/cla
128 lines
5.5 KiB
Markdown
128 lines
5.5 KiB
Markdown
# Code of Conduct
|
|
|
|
We have a [code of conduct](CODE_OF_CONDUCT.md) that we all must
|
|
read. Be polite to everyone. If you are not in your best day, take a
|
|
deep breath and try again. Smile :smile:
|
|
|
|
# New Issues
|
|
|
|
Before you submit an issue:
|
|
|
|
* 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.
|
|
|
|
# Compilation problem
|
|
|
|
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.
|
|
* Remember that might be some [pull requests](https://github.com/aseprite/aseprite/pulls)
|
|
being reviewed to fix your same problem.
|
|
|
|
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 creating a [GitHub issue](https://github.com/aseprite/aseprite/issues/new).
|
|
|
|
# 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](https://aseprite.deviantart.com/), 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) twitter account, or
|
|
[buying an extra Aseprite copy to your friend](https://www.aseprite.org/download/).
|
|
|
|
Other ways to contribute require direct contact with us. For example:
|
|
|
|
* [Writing documentation](https://github.com/aseprite/docs).
|
|
* Making art with Aseprite and for Aseprite (logos, skins, mockups).
|
|
* Sending patches for features or bug fixes.
|
|
* Reviewing issues in the [issue tracker](https://github.com/aseprite/aseprite/issues) and making comments.
|
|
* Helping other users in the [Community](https://community.aseprite.org/) site.
|
|
|
|
## Documentation
|
|
|
|
You can start seeing the
|
|
[documentation](https://www.aseprite.org/docs/), and
|
|
[contact us](mailto:support@aseprite.org) if you want to help
|
|
writting documentation
|
|
or recording [tutorials](https://www.aseprite.org/docs/tutorial/).
|
|
|
|
If you are going to write documentation, we recommend you to take
|
|
screenshots or record a GIF animations to show steps:
|
|
|
|
* As screen recording software, on Windows you can generate GIF files
|
|
using [LICEcap](http://www.cockos.com/licecap/).
|
|
* You can upload the PNG/GIF images to [Imgur](http://imgur.com/).
|
|
|
|
## Reviewing Issues
|
|
|
|
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.
|
|
|
|
## Hacking
|
|
|
|
The first thing to keep in mind if you want to modify the source code:
|
|
checkout the **main** branch. It is the branch that we use to
|
|
develop new features and fix issues that are planned for the next big
|
|
release. See the [INSTALL](INSTALL.md) guide to know how to compile.
|
|
|
|
To start looking the source code, see how it is organized in
|
|
[src/README.md](https://github.com/aseprite/aseprite/tree/main/src/#aseprite-source-code)
|
|
file.
|
|
|
|
## Forking & Pull Requests
|
|
|
|
You can fork the GitHub repository using the Fork button at
|
|
[https://github.com/aseprite/aseprite](https://github.com/aseprite/aseprite).
|
|
|
|
The Pull Requests (PR) systems works in this way:
|
|
|
|
1. First of all you will need to sign our
|
|
[Contributor License Agreement](https://github.com/igarastudio/cla) (CLA).
|
|
1. Then you can start working on Aseprite. Create a new branch from `main`, e.g. `fix-8` to fix the issue 8.
|
|
Check this guide about [how to name your branch](https://github.com/agis/git-style-guide#branches).
|
|
1. Start working on that new branch, and push your commits to your fork.
|
|
1. Create a new PR to merge your `fix-8` branch to the official `main`.
|
|
1. If the PR is accepted (does not require review/comments/modifications),
|
|
your branch is merged into `main`.
|
|
1. You will need to pull changes from the official `main` branch, and
|
|
merge them in your own `main` branch. Finally you can discard your
|
|
own `fix-8` branch (because those changes should be already merged
|
|
into `main` if the PR was accepted).
|
|
1. Continue working from the new `main` head.
|
|
|
|
To keep in mind: **always** start working from the `main` head, if you
|
|
want to fix three different issues, create three different branches
|
|
from `main` and then send three different PR. Do not chain all the
|
|
fixes in one single branch. E.g. `fix-issues-3-and-8-and-25`.
|
|
|
|
## Community
|
|
|
|
You can use the [Development category](https://community.aseprite.org/c/development)
|
|
to ask question about the code, how to compile, etc.
|
|
If you want to start working in something
|
|
([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 start programming in something that is already
|
|
done for the next release or which someone else is working on.
|
|
|
|
And always remember to take a look at our
|
|
[roadmap](http://www.aseprite.org/roadmap/).
|