The inventory-framework project is a collaborative effort from the start. The team thinks that contributions from different developer will enrich its feature set and make it more relevant to the community.
However, absorbing all contributions as-is, while expedient, might lead to difficulties in maintenance of the codebase is left unchecked. A collaborative codebase often establish guidelines for contributors to ensure code remains maintainable over time. The effort to maintain the library is no different in this regard, so a bit of guidance is in order.
The purpose of this guide is to set a baseline for contributions. These guidelines are not intended to limit the tools at your disposal nor to rewire the way you think but rather to encourage good neighbor behavior.
We use english language. This is to be consistent everywhere, and to be considerate with developers that do not speak our native language.
Therefore: source code, comments, documentation, commit messages, review comments, and any other kind of contribution * MUST* use english language.
Typos are unavoidable, but try to reduce them by using a spellchecker. Most IDEs can be configured to run one automatically.
Comments in code are a hard thing to write, not because the words are difficult to produce but because it is hard to make relevant comments. Too much of it and people do not read comments (and it obfuscates code reading) and too little of it gives you no recourse but to read large portions of codebase to get insight as to what a feature/codeblock is doing. Both situations are undesirable and efforts should be made at all time to have a please comment reading experience
As a general rule you would have to comment on decisions you made while coding that are not part of any specification.
In particular, you should always comment any decision that:
- Departs from common wisdom or convention (The why's are necessary).
- Takes a significant amount of time to produce. A good rule of thumb here is that if you spent more than 1 hour thinking on how to produce a fragment of code that took 2 minutes of wrist time to write you should document your thinking to aid reader and allow for validation.
- Need to preserve properties of the implementation. This is the case of performance sensitive portions of the codebase, goroutines synchronization, implementations of security primitives, congestion control algorithms, etc.
As a general rule of what not to comment you should avoid:
- Commenting on structure of programs that is already part of a convention, specified or otherwise.
- Having pedantic explanations of behavior that can be found by immediate examination of the surrounding code artifacts.
- Commenting on behavior you cannot attest.
Currently master is our only long term branch, below a few suggestions of short term branches naming:
fix/something-needs-fix: Small routine patches in code to feature already there.feat/something-new: A new feature or a change in an existent feature. Beware of breaking changes that would require a major version bump.docs/improves-documentation-for-this-feature: If you add or change documentation with no impact to the source code.chore/update-gradle-version: If you need to update any project files not related to source code
All commits SHOULD follow the seven rules of a great Git commit message:
- Separate subject from body with a blank line.
- Limit the subject line to 72 characters.
- Capitalize the subject line.
- Do not end the subject line with a period.
- Use the imperative mood in the subject line.
- Wrap the body at 72 characters.
- Use the body to explain what and why vs. how.
Commits such as "fix tests", "now it's working", and many other common messages we find usually in code WON'T be accepted.
Ideally we would like to enforce these rules, but we are realistic and understand that it might be a big change for some people. So unless deviating heavily from what was stated we might accept your commits even if not following these rules perfectly.
Please avoid taking too much time to deliver code, and always rebase your code to avoid reverse merge commits.