Introduction

We want to make it as easy as possible for Gitote users to become Gitote contributors, so we’ve created this guide to help you get started. We have multiple tracks to cater to people of varying experience levels.

If you’re uncomfortable getting into open source development right away, you may want to consider the Documentation track. Documentation are just as important as code, and we'd be happy to have your contributions.

Development

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior can be reported by emailing me@yoginth.com.

This Code of Conduct is adapted from the Contributor Covenant version 1.1.0, available at http://contributor-covenant.org/version/1/1/0/.

Documentation

These instructions are for development of Gitote specifically. Please note that use of the Gitote Development Kit is currently experimental on Windows and macOS. Linux is recommended for the best contribution experience.

1. Read Gitote Development Kit, see the GDK README for instructions on setting it up and.
2. Fork the Gitote project.
3. Choose an issue to work on. * You can find easy issues by looking at issues labeled Accepting Merge Requests
   • Be sure to comment and verify no one else is working on the issue, and to make sure we’re still interested in a given contribution.
   • You may also want to comment and ask for help if you’re new or if you get stuck. We’re happy to help!
4. Add the feature or fix the bug you’ve chosen to work on.
5. Open a pull request. The earlier you open a pull request, the sooner you can get feedback. You can mark it as a Work in Progress(In issue name) to signal that you’re not done yet.
6. Make sure the test suite is passing here.
7. Wait for a reviewer. You’ll likely need to change some things once the reviewer has completed a code review for your pull request. You may also need multiple reviews depending on the size of the change.
8. Get your changes merged!

For more information, please see the Developer Documentation.