Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

45 lines (24 loc) · 2.74 KB
Raw

Contribution Guidelines

Thank you for considering contributing to our Django project! We welcome all contributions that align with our project's goals and guidelines. Before contributing, please review the following guidelines to ensure a smooth and effective collaboration process.

Branches

Our project has two main branches:

  • main: This branch is the stable production-ready branch. It contains the latest stable version of the project.
  • develop: This branch is the main development branch. It contains the latest changes and is where all new features and bug fixes should be developed.

Contribution Process

  1. Send an Email to [email protected]: Before contributing, please send an email to [email protected] expressing your interest in contributing. Once your request is reviewed and accepted, you will be added to the repository as a contributor.

  2. Clone the Repository: After being added as a contributor, clone the repository to your local machine using the following command: git clone https://github.com/ma-za-kpe/linky_project.git

  3. Switch to the Develop Branch: Before making any changes, switch to the develop branch using the following command: git checkout develop

  4. Create a New Branch: Create a new branch for your contribution. Make sure to name your branch descriptively, indicating the purpose of your changes: git checkout -b your-branch-name

  5. Make Changes: Make your desired changes to the codebase. Ensure that your changes adhere to our coding standards and guidelines.

  6. Commit Changes: Once you are satisfied with your changes, commit them to your branch: git add . and git commit -m "Your commit message"

  7. Push Changes: Push your changes to your fork of the repository: git push origin your-branch-name

  8. Create a Pull Request (PR): Once your changes are pushed, create a pull request (PR) from your branch to the develop branch. Provide a clear and descriptive title and description for your PR.

  9. Review and Merge: Your PR will be reviewed by our team. If any changes are requested, make the necessary updates and push them to your branch. Once your PR is approved, it will be merged into the develop branch.

Code of Conduct

Please note that we adhere to a Code of Conduct in all interactions related to our project. By contributing, you are expected to uphold this code of conduct.

Questions and Support

If you have any questions or need support regarding the contribution process, please reach out to [email protected].

Thank You!

Thank you for contributing to our Django project! Your contributions help us improve and grow. We appreciate your efforts and look forward to collaborating with you.

You can copy and paste this Markdown text into your CONTRIBUTING.md file