Skip to main content

Contributing to GNOME-Nepal

Thank you for showing an interest in contributing to GNOME-Nepal! All kinds of contributions are valuable to us. In this guide, we will cover how you can quickly onboard and make your first contribution.

Table of Contents​

Code of Conduct​

Please read and adhere to our Code of Conduct. By participating, you agree to abide by its terms.

How to Contribute​

You can contribute in several ways:

  • Reporting bugs
  • Suggesting features or enhancements
  • Writing or improving documentation
  • Submitting bug fixes or enhancements

Getting Started​

  1. Fork the repository: Fork the repository to your GitHub account by clicking the "Fork" button on the repository page.

  2. Clone the forked repository:

    git clone https://github.com/GNOME-Nepal/website.git
    cd website

  3. Set up the upstream remote:

    git remote add upstream https://github.com/GNOME-Nepal/website.git

  4. Create a branch for your changes:

    git checkout -b your-branch-name

Development Workflow​

  1. Keep your fork up to date:

    git fetch upstream
    git checkout main
    git merge upstream/main

  2. Make your changes: Implement your changes in the relevant files.

  3. Test your changes: Ensure your changes work as intended and do not introduce new issues.

  4. Commit your changes:

    git add .
    git commit -m "Description of the changes"

  5. Push your changes:

    git push origin your-branch-name

Submitting Changes​

  1. Create a Pull Request: Go to the repository on GitHub and click the "New Pull Request" button. Follow the prompts to submit your pull request.

  2. Describe your changes: Provide a detailed description of your changes, including the motivation behind them and any relevant issue numbers.

  3. Ensure all checks pass: Make sure your pull request passes all automated checks and reviews.

Reporting Issues​

If you encounter any issues, please report them using the Issue Tracker. When reporting an issue, please include:

  • A clear and descriptive title
  • A detailed description of the problem
  • Steps to reproduce the issue
  • Any relevant logs or screenshots

Style Guide​

Please follow the project's style guide to ensure consistency. This includes code formatting, naming conventions, and documentation standards. Refer to the Style Guide for more information.

Code Reviews​

All submissions, including pull requests, are reviewed. We aim to provide feedback within a reasonable timeframe. Contributions that do not align with the project's goals or guidelines may be rejected.

License​

By contributing, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for your interest in contributing! If you have any questions, feel free to reach out to the maintainers or open an issue for assistance.