Contributing Guidelines
Welcome to the contribution guidelines for Giraffe's open source Job's Ontology platform. This guide explains how to contribute to our project as well as define our working practices. This project is relatively new, as is this documentation - if you have any suggestions, please feel free to drop us a line at info@giraffe.co.za
Table of Contents
- Asking Support Questions
- Reporting Issues
- Set up a Development Environment
- Feature Request (open a pull request)
- Steps to submit a pull request
- Labels/ Tags
1. Asking Support Questions
If you have any support question please email us directly at info@giraffe.co.za (use "Job's Ontology Support" in the subject)
2. Reporting Issues
If you believe you have found a defect or a bug on Giraffe's Job's Ontology or our documentation, use the GitLab issue tracker to report the problem to our maintainers. If you're not sure if your issue is a bug or not, you're welcome to start with a support question by emailing info@giraffe.co.za (use "Job's Ontology Support" in the subject).
When reporting the issue, please provide all the relevant details including which aspect of the platform is affected, as well as the type of issue you're experiencing. We've added projects and tags to make this process easier.
Submit issues here: https://gitlab.com/groups/giraffe-unicef/-/issues
3. Set up a Development Environment
See here: https://giraffe-unicef.gitlab.io/job-recommendation/docs/project_setup/
4. Feature Request (open a pull request)
These guidelines help maintainers review new pull requests. Please stick to the guidelines for quicker and easier pull request reviews
Address the following questions in your pull request:
- What is a short summary of your change?
- Why is this change helpful?
- Any specific details to consider?
- What is the desired outcome of your change?
5. Steps to submit a pull request
- Find the project you want to contribute to
- Fork it
- Clone it to your local system
- Make a new branch
- Make your changes
- Push it back to the repo
- Click the Compare & pull request button
- Click Create pull request to open a new pull request
- Select the “feature request” template and fill it in
- Submit your change!
6. Labels/ Tags
Below is a list of labels/ tags to easily classify your contribution. Where applicable, tag from this list when submitting your contribution
Bug | #eb2f06 |
Improvement | #6a89cc |
Feature | #78e08f |
Admin FrontEnd | #079992 |
User FrontEnd | #38ada9 |
BackEnd | #0a3d62 |
Critical | #b71540 |
Discussion | #fad390 |
Documentation | #fa983a |
Support | #e58e26 |
Suggestion | #82ccdd |
Regression | #60a3bc |