Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 3.71 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 3.71 KB
Raw

Welcome to the Epitome project

You have our deep gratitude for deciding to contribute to the development of Epitome. You can help the project by contributing new features, patches, bug reports, tutorials, documentation, and artwork. We welcome all contributors regardless of skill or experience level. We want to make participation as easy as possible, by providing support to contributors, especially those who are new. This can include providing feedback on your patches among other things. However by following the guidelines below contributors can decrease the amount of support required, which makes the process easier and better for everyone.

We expect all contributors uphold a positive and respectful behaviour as explained in the Code of Conduct.

Reporting bugs and issues

  • Please first make sure that your issue is not already reported, by using the GitHub issue search as it would greatly help to gather information about different instances of a single bug.
  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. Don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened.

Contributing code

  • Fork the project, clone it in your local machine and make your changes.

  • We encourage testing before merging a pull-request. Pull Requests should usually be made for the development branch as this contains the most recent version of the code.

  • Push the changes to your fork and submit a new pull request with a clear list of what you've done and a descriptive title.

  • All contributions must be made under the AGPL3 license. No transfer of copyright or other rights or permissions is required. Specifically add this in the beggining of each new file:

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <Your real first and last name here>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

Other contributions

  • If you find something undocumented whose behaviour is unlikely to change, consider filling in that part of the DOCUMENTATION.md file.

Contact

If you would like to contact us for any reason please fill out a form in our contact page or join us in our Riot.im chat room and we will be in contact with you soon.