This repository is meant to centralize reusable tools and, the most important, knowledge. Anyone in the group can contribute without asking for permission. It contains code, documents and the wiki.
Contributing is as simple as uploading a file (em português) or creating/editing a wiki page (em português).
Don't know how to format or where to put things? Don't worry: write it down now and organize later. The repository and the wiki will always be a work in progress and, therefore, incomplete and imperfect by nature. Anyway, here are some recommendations by type of contribution:
- Add some information about new files to the directory's README document. Create it if doesn't exist yet.
- Include comments in the code explaining how it works and how it is supposed to be used.
- Though not strictly necessary, it is good practice to follow common coding conventions.
- If a program has external dependencies or needs specific compilation flags, include this information in the comments —or create a
Makefile.
- Add a link to the document in the appropriate wiki page (creating it if necessary).
- Be judicious when uploading big files (>1MB) as they can significantly slow down a
git cloneoperation.
- Always add references to the original sources of information to the page footer.
- Should you include an image in the text, use online images or follow these instructions.