Skip to content

Latest commit

 

History

History
113 lines (80 loc) · 3.02 KB

CONTRIBUTION_GUIDELINES.md

File metadata and controls

113 lines (80 loc) · 3.02 KB

Custos-Mobile (React Native) Contributor Guidelines

Thank you for your interest in contributing to the Custos-Mobile app, built with React Native! We welcome contributions of all types, from bug fixes to feature enhancements. Please follow these guidelines to ensure a smooth and efficient contribution process.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Setting Up the Project
  4. Branching and Commit Guidelines
  5. Pull Requests
  6. Coding Standards
  7. Styling Guidelines
  8. Issue Reporting
  9. Resources
  10. License

1. Code of Conduct

Please read and adhere to our Code of Conduct. We expect contributors to engage respectfully and professionally.

2. How to Contribute

Ways you can contribute to Custos-Mobile:

  • Report Bugs: Create a GitHub issue to report bugs.
  • Submit Feature Requests: Open an issue to suggest features.
  • Fix Bugs/Implement Features: Submit a PR for an open issue.
  • Improve Documentation: Enhancements to documentation are appreciated.

3. Setting Up the Project

Before contributing, set up the project locally:

  1. Fork the repository.
  2. Clone your fork: 
    git clone https://github.com/your-username/custos-mobile.git
  3. Navigate to the project directory: 
    cd custos-mobile
  4. Install dependencies: 
    npm
  5. Run the project: 
    npm start
  6. Ensure everything works before making changes.

4. Branching and Commit Guidelines

  • Branch Naming:

    • feature/your-feature-name for new features.
    • bugfix/issue-number-description for bug fixes.

  • Commit Messages:

    • Use meaningful, concise messages.
    • Example: 
      feat: add dark mode support for mobile app

5. Pull Requests

  • Ensure your branch is up to date with the main branch.
  • Open a PR against the master branch.
  • Provide a detailed description of your changes.
  • Reference any relevant issues.

6. Coding Standards

  • React Native: Follow React Native best practices.
  • Code Quality: Write clean, maintainable code. Ensure functions and variables have meaningful names.
  • Testing: Write tests for your changes. Run tests before submitting a PR.

7. Styling Guidelines

  • We use Styled Components for styling. Refer to the Styled Components documentation for guidelines.
  • Ensure that any new styles align with the design system.

8. Issue Reporting

When reporting issues:

  • Use a clear and descriptive title.
  • Provide details about the issue, steps to reproduce, and environment information.
  • Attach screenshots or logs if applicable.

9. Resources