opensourcemirror
/
ipfire-2.x
mirror of git://git.ipfire.org/ipfire-2.x.git
1
0
Fork 0
Code Issues Releases Wiki Activity
ipfire-2.x/doc/CONTRIBUTING.md

47 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
# How can I help?
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
You can help in numerous ways. This document should give you an overview of what
is possible and how you can get involved. It will **not** give you all information
you need to successfully contribute to avoid content duplication between this
document and our [wiki](https://wiki.ipfire.org/). Instead, it should guide you
to the right places to look for further information.
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
## Development
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
All information is available in the [development section](https://wiki.ipfire.org/devel)
of our wiki. The following is a very short overview of the most important topics.
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
### Contact
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
We use the mailing list `<development@lists.ipfire.org>` for our communication. For the
list archive and registration, see [here](http://lists.ipfire.org/mailman/listinfo/development).
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
### Source Code
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
We use our own infrastructure for code hosting, accessible at `git.ipfire.org`. The
GitHub repositories are **only** mirrors of `git.ipfire.org`, available as a courtesy
to the internet community.
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
### How to build the distribution?
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
In order to contribute, you certainly need to build the distribution at some point.
See [here](https://wiki.ipfire.org/devel/ipfire-2-x/build-howto) for a long guide
how to do that.
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
### Reporting bugs
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
We have a bug tracker located [here](https://wiki.ipfire.org/devel/bugzilla). Further
information can be found in our [wiki](https://wiki.ipfire.org/devel/bugzilla). We do
**not** use GitHub for tracking bugs.
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00
### Contribute changes to the source code
Improve README and CONTRIBUTING - Strip tailing whitespaces - Use shorter line length to make reading the files with editors or terminals without automatic line break easier - Slightly improve the content of these files Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
2022-03-21 14:47:58 +01:00
Unfortunately, we do not accept GitHub pull requests. Instead, we are working with patches
which are sent to our mailing list `<development@lists.ipfire.org>`. This process might
be a bit tricky in the beginning. That's why you can find more information how to do
this [here](https://wiki.ipfire.org/devel/submit-patches).
Add Readme and Contributing guidelines. For people which just have found our source code especially over GitHub sometimes seem to have problems finding out how to contribute. This is sad as it prevents us building a bigger community. While we have a wiki which conatins a lot informations, this seems to get overlooked. I guess a contributing fact is that most software today has these informations contained in the repository itself. While I am not going to duplicate the wiki to have these informations in our repository I still think it is a good idea to have a short guide to lead new contributers into the right direction. Someone now could argue that new people just a too * to look at the right place and that's why we do not need these documents. I do not think so because of several points: First people get used to look for information at a readme. I guees that is because of the fact both GitHub and Gitlab place the readme so prominently. Second starting in a new project is hard. Finding the right place where to start is also not easy as every project is different. Giving people a short introduction what the first steps could be is definitely needed. Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
2022-03-08 12:18:24 +01:00