Skip to main content

Guidelines

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

This document proposes guidelines for contributing to the La Tech Force Engine repository.

The objectives of the guidelines are:

  • Make sure that contributing is an enjoyable experience, and that contributors are respected. (e.g. avoid endless discussions and flame wars)
  • Make sure that the quality of the codebase increases over time. (or at least remains stable)
  • Make sure that contributions solve more problems than they create. (e.g. a "fix" that was not tested properly will cause long discussions)
  • Make sure to not wasting other contributors' time.

These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

What to contribute​

You can contribute to La Tech Force Engine in various ways:

  • Fix bugs or contribute to the development of features on which help is wanted: see our To Do list
  • Submit Github issues for bugs you (or other users) found (template)
  • Give feedback, suggest feature and/or provide value in ongoing discussions in issues and pull requests

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub. And don't hesitate to ask for assistance by posting a message in any of the Github issues that you would like to contribute to.

Acceptance criteria for Pull Requests (PR)​

  • A PR must address just one Github issue. Any PR that address zero or more than one Github issue (e.g. "cleaned .gitignore and added installation guide" are two independant PR) will be rejected.
  • A PR must not break any functionality of the product. Every precaution (e.g. writing and running automated tests) must be taken to avoid that.

Core principles​

More generally, make sure to follow these three principles:

  • Keep your PRs short
  • Keep your PRs simple
  • Avoid submitting PRs that may cause long discussions with the PR reviewer and/or other contributors

🤗 Beginners, you are welcome too! Don't be afraid, sending a PR is a great way to learn. You will probably be reassured by this article: How To Win Friends And Make Pull Requests On GitHub, and don't hesitate to ask for help.

Code guidelines​

  • Optimize for search: Like in the React.js project, we want to make it easy for contributors to search for symbols (constants, variables and function names). So don't hesitate to give them verbose/specific names.