You are welcome to add anything that will cause improvement to the documentations, the source code or the user experience of the application of interest in this project, but it is important the you follow these instructions to avoid unecessary conflicts and to maintain the orderliness in the work.
The first thing you should do (after identifying the problem you want to solve and knowing what the application is about) is to fork the repository and clone it on your local machine. Know how to run the application locally, so that you can test to see how it works (refer to the readme of the app).
Once you have cloned the repository (which now looks like your own repo), create a new branch, as the main branch is protected and you cannot merge directly or push to it.
You are to adhere to the following naming conventions while creating your branch.
Begin the branch name with the <prefix> followed by a forward slash (/) and <a_very_short_description>; you may use hyphens (-) or underscores (_)
to separate words. For example; docs/correct-typo. You may include issue or task number but that's optional.
The commit messages (when you push to git) should as well take the format <prefix>(<short_subject>): <a_brief_and_precise_description>. For example docs(README): updated the instruction for usage
Below are the prefixes that you might want to use, based on the kind of contribution you want to make to the project, and the brief descriptions, so that you'll choose the right one for naming your branch and writing your commit messages.
| Prefix | Description |
|---|---|
| feature | Represents a new functionality or feature added to the software, typically user-facing and contribute to the overall enhancement of the application |
| chore | Refers to tasks that are necessary for the project but don't add new features or fix bugs directly. Examples include maintenance tasks, refactoring, or other non-functional improvements |
| hot-fix | A quick, unplanned patch or solution to address a critical bug or issue in the production environment. Hot-fixes are often created and deployed urgently to resolve immediate problems |
| config | Short for configuration. This category may include changes related to configuration files, settings, or environment-specific adjustments, ensuring the software adapts to different environments |
| docs | Involves documentation-related changes. This can include updating or adding documentation for code, processes, or other aspects of the project |
| style | Refers to changes made to improve the code style or formatting without affecting the actual functionality. This might include indentation, whitespace, or naming conventions |
| performance | Involves optimizations aimed at improving the performance of the software. This could include changes to algorithms, data structures, or resource utilization to make the system more efficient |
Now you can make your desired modifications or contributions to the codebase. Remember to always keep in mind the project goals and adhere to the project coding conventions.
When your modifications and contributions are ready, create a pull request to the development branch, named dev.
Please do not do anything with or on the
mainbranch, as it may not be accepted, your work needs to make it to thedevbranch first
When creating a pull request, be sure to include (where necessary) a detailed description and the necessary information such as screenshots, videos, or GIFs.
Before submitting the pull request, review all changes thoroughly to make sure they meet the project goals and coding conventions. Your contribution may have to pass certain requirements and tests for the pull request to be accepted
Thank you for you understanding. For help or more info, contact Topman Paul-Dike