Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 4.66 KB

CONTRIBUTION.md

File metadata and controls

89 lines (57 loc) · 4.66 KB
Raw

Pixel Perks - Contribution Guidelines

Welcome to the Pixel Perks open-source project! We appreciate your interest in contributing to our app. Before you get started, please take a moment to review these contribution guidelines.

1. Getting Started ▶️

First things first, To contribute effectively to PixelPerks, you need to follow these steps.

  • Create a file called .env at the root of your project working directory.

  • Open the .env file and add the following variables like this,

SECRET="YOUR_PIXABAY_SECRET_KEY"
EMAIL="YOUR_EMAIL_ID"

  • You can obtain your Pixabay api key from here. May need to signing if you don't have an account.

  • You may check the backend server repository, made with express.js

  • Follow the api documentation for more information.

2. How to Contribute

🐛 Reporting Bugs 🐛

If you encounter a bug while using Pixel Perks, please help us by following these steps:

  1. Check the GitHub Issues to see if the issue has already been reported. If it has, you can add additional information or subscribe to receive updates.

  2. If the issue is not yet reported, please create a new issue with a clear and concise description of the problem. Include relevant details such as your operating system, device, and steps to reproduce the issue.

🆕 Suggesting Features 🆕

You can also suggest new features or improvements by opening an issue in the repository. Please make sure this feature is not already suggested by others. If it is not please create a new issue and clearly describe the new feature in your mind. Be sure to mention why you believe it would be valuable to other users.

Pull Requests

We welcome contributions from the community! To submit a pull request, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone this repository in your local machine. 
    git clone YOUR-FORKED-REPOSITORY-URL
  3. Create a new branch for your changes. 
    git checkout -b new_feature/fix
  4. Make your changes, following the coding guidelines (see Coding Guidelines).
  5. Write tests for your code when applicable.
  6. Commit your changes with short descriptive message. 
    git commit -m "Added new_feature or fix_issue #X: description of changes"
  7. Push the changes in your local repository 
    git push new_feature/fix
  8. Create a pull request (PR) to the main branch of Pixel Perks repository. In your PR, provide a detailed description of your changes, including the problem they solve and any new dependencies.

Coding Guidelines

At Pixel Perks, we believe that clean and well-structured code is essential for maintainability and collaboration. Here are some coding guidelines to keep in mind while contributing:

  • Use descriptive and meaningful names for variables and functions. Avoid single-letter variable names or overly cryptic abbreviations. Code readability is crucial.

  • Add comments when necessary to explain complex logic or non-obvious code behavior. Comments should provide context and help fellow developers understand your thought process.

  • Through Testing

    • Write unit tests for your code to ensure it behaves as expected and to prevent regressions. Test both normal and edge cases to cover a wide range of scenarios.
    • Perform integration tests to verify that different components of the app work together seamlessly. This is especially important when making changes that affect multiple parts of the app.
    • Before submitting your code, run the existing test suite to ensure that your changes do not break any existing features or functionality.

By adhering to these coding guidelines, you'll contribute to a more maintainable and collaborative development environment for Pixel Perks.

3. License

By contributing to Pixel Perks, you agree that your contributions will be licensed under the Apache-2.0 license and remain open source for all.

Happy coding! 🚀

Thank you for your interest in contributing to Pixel Perks! Your help is greatly appreciated, and together we can make Pixel Perks even better. If you have any questions or need assistance, feel free to reach out at moinak2000@gmail.com or visit