Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: update contribution guide regarding pull requests #1637

Merged
merged 1 commit into from
Jan 21, 2025
Merged

readme: update contribution guide regarding pull requests #1637

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Source for nixos.org

[![CI](https://github.com/NixOS/nixos-homepage/actions/workflows/ci.yml/badge.svg)](https://github.com/NixOS/nixos-homepage/actions/workflows/ci.yml)
[![Number of open GitHub issues](https://img.shields.io/github/issues/nixos/nixos-homepage?style=flat&color=red)](https://github.com/nixos/nixos-homepage/issues)
[![Number of open GitHub pull requests](https://img.shields.io/github/issues-pr/nixos/nixos-homepage?style=flat&color=blue)](https://github.com/nixos/nixos-homepage/pulls)
Expand All @@ -22,6 +23,16 @@ Here’s how you can help us achieve that:
- Focus on contributions that align with the project's long-term goals and maintainable growth.
- Be mindful of the maintainers’ capacity. We, like you, are here because we are passionate about the project.

## Small Changes and Fixes

If you find a bug or need to make a small content change, feel free to submit a pull request.
There is no need to create an issue if the change is sufficiently small.
Here are a few examples:

- [An image was in the wrong location](https://github.com/NixOS/nixos-homepage/pull/1630)
- [Updating team members](https://github.com/NixOS/nixos-homepage/pull/1636)
- [Fixing the logic for asciinema-player](https://github.com/NixOS/nixos-homepage/pull/1597)

## All Work is Tracked in Issues

All work, whether proposed or in progress, should be documented in Issues.
Expand Down Expand Up @@ -50,6 +61,12 @@ When submitting pull requests, ensure they are categorized as one of the followi

Avoid combining these types in a single pull request to make the review process smoother and more efficient.

Make sure to add a description in your pull request.
A few words can help reviewers understand your intent.
For example, if you are making design changes, you might want to answer why your changes are an improvement.
Similarly, if you are making technical changes, you might want answer how your changes work.
Add enough detail so we know what you know.

# Development

To run local development instance follow this steps to start a local server
Expand Down Expand Up @@ -95,7 +112,6 @@ substituters = ... https://nixos-homepage.cachix.org
trusted-public-keys = ... nixos-homepage.cachix.org-1:NHKBt7NjLcWfgkX4OR72q7LVldKJe/JOsfIWFDAn/tE=
```


## License

The content of the website is licensed under the [Creative Commons Attribution Share Alike 4.0 International](LICENSES/CC-BY-SA-4.0.txt) license.
Expand Down
Loading