Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (26 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

46 lines (26 loc) · 2.46 KB

Contributing to Gettext-Helpers

First off, thanks for your interest in helping out!

Important Note: First and foremost, the purpose of the code in this repository is to build the translations for Spyder, the Scientific Python Development Environment. Therefore, all additions, changes and removals should not conflict with or otherwise hinder its ability to do so. Thanks!

For more guidance on the basics of using git and Github to contribute to Spyder and its documentation, please see the contributing guidelines in the main Spyder repository mentioned above, and check out the Spyder Development Documentation for detailed instructions.

Reporting Issues

If you encounter an issue using Gettext-Helpers, spot a bug in the code, or have a suggestion for improving it further, please let us know by submitting a report on our Github Issue Tracker. Make sure you provide as much information as possible to help us track down the issue, and we always appreciate offers to help resolve it yourself. Thanks!

Submitting Pull Requests

We welcome contributions from the community, and will do our best to review all of them in a timely fashion. To do so, please fork this repository, create a new feature branch there based off the latest master, make and test your changes, and then submit a pull request (PR) to this repo. Please make sure your PR titles are brief but descriptive, and include PR: as a prefix (if a work in progress, also prefix [WiP]).

You should also create a corresponding issue as well if your change is substantive, so that we can keep track of everything and give you credit for closing it. You might want to open an issue first discussing your changes, to get feedback and suggestions before implementing them.

Standards and Conventions

Make sure you follow these to ensure clarity, consistency and correctness throughout our codebase.

  • reStructuredText (rst) for documentation format
  • PEP 8 style for Python code, with all recommendations treated as requirements unless noted
  • PEP 257 for all docstrings
  • 79 characters for line length
  • UTF-8 for character encoding
  • LF for newlines
  • ISO 8601 (YYYY-MM-DD HH:MM:SS) for dates/times
  • SI/metric for units
  • Always include the standard header (see any Python file) in any new file you create.

Thanks so much!