You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.
The developer docs have been a great starter for how to contribute to the project. However, it's starting to show its age and is not as detailed and comprehensive as it could be.
I'm proposing a restructure of the docs as follows:
Include "Reporting bugs and requesting features" (aka how to open issues on Github) and "Improving the documentation" into the developer guide. These are all non-code contributions but are just as needed (if not more).
Separate the docs on different pages (this will go along with Separate the developer docs into different files #220) but the separation should be made by barrier-to-entry level (from smallest to largest) : giving feedback; contributing text/docs; contributing code; git+github workflow; project administration (making releases and packaging).
Rename "Developer Guide" to "Contributing" or "Getting involved". "Developer" might put newcomers off.
Each page would have the following content:
Giving feedback
What are the options for this: mailing list and issues (preferred)
How should you behave on our forums (a code of conduct)
What to expect from us (polite/friendly replies but we won't implement something just because you asked)
Where is the mailing list and what you need to subscribe
What is an issue and how make one.
Improving the documentation
The docs are always evolving and need your help
How the documentation is generated and where does it live (source and built pages)
Where you should go to learn how to use sphinx
How to build the docs locally
The format that we use for docstrings etc
Contributing something to the docs (point to git workflow)
Contributing code
How to find things to work on (issues and low-hanging fruit)
Tell us what you plan and ask if we'd accept this contributing (create/post issue or write to mailing list)
What we expect from contributed code (readable, tested, documented)
What you can expect from us during the code review (we'll be polite and helpful, review thoroughly, etc)
Where the code lives and how it's structured
Quickly download a copy and build + test it locally
How to manage and submit your contributing (point to git workflow)
How to test your code
How to document your code (point to improving docs section)
How profile and improve your code
Git workflow
(Thanks to @PiotrKurnik for pointing out that we need this a lot)
How to get a fork
Clone your fork locally
Work on branches
Submit a PR (earlier rather than later) and the review
Continuous integration checks
Keeping your fork updated (fetching from upstream master)
Project management
(This is what is currently only in my head. I'd like to put this out there in case someone else wants to help or take over the work.)
How to package the project (what's in setup.py)
Checking your package
Tag the release and mark it on Github
Update the website
Uploading to PyPI
Creating conda packages (this is something I have to figure out as well but conda-forge seems like the way to go)
Pinging all @fatiando/contributors. Is anything missing? Is the order OK? What are your thoughts on this?
The text was updated successfully, but these errors were encountered:
The developer docs have been a great starter for how to contribute to the project. However, it's starting to show its age and is not as detailed and comprehensive as it could be.
I'm proposing a restructure of the docs as follows:
Each page would have the following content:
Giving feedback
Improving the documentation
Contributing code
Git workflow
(Thanks to @PiotrKurnik for pointing out that we need this a lot)
Project management
(This is what is currently only in my head. I'd like to put this out there in case someone else wants to help or take over the work.)
setup.py
)Pinging all @fatiando/contributors. Is anything missing? Is the order OK? What are your thoughts on this?
The text was updated successfully, but these errors were encountered: