Hosting New Project
Oct 08, 2021
Dec 20, 2023
We're excited to have your project hosted with us. To ensure a seamless experience for contributors, maintainers, and users, please adhere to the following guidelines:
1. Project Suitability:
- Ensure your project aligns with N3N's values and is relevant to our community.
2. Project Documentation:
- Provide comprehensive documentation to help users understand your project, contribute effectively, and troubleshoot issues.
3. Code of Conduct:
- Include a clear and concise Code of Conduct that fosters a welcoming and inclusive environment for all contributors and users.
4. License:
- Choose an open-source license compatible with N3N's licensing policies. Clearly state the license in your project's repository.
5. Readme:
- Create a well-structured README file with essential information about your project, including installation instructions, usage guidelines, and contribution details.
6. Issue Tracker:
- Utilize the issue tracker for bug reports, feature requests, and general project discussions. Respond promptly to issues and pull requests.
7. Pull Request Process:
- Clearly outline the process for submitting pull requests, including any required tests, code review expectations, and the overall contribution workflow.
8. Versioning:
- Follow semantic versioning principles to clearly communicate the impact of changes and updates to users and contributors.
9. Continuous Integration:
- Implement a CI/CD pipeline to automate testing and ensure code quality. Indicate the build status in your repository.
10. Community Engagement:
- Encourage a vibrant and engaged community by promptly responding to queries, recognizing contributors, and fostering a collaborative atmosphere.
11. Security:
- Prioritize the security of your project. Provide clear instructions for reporting vulnerabilities and promptly address security-related issues.
12. Project Archival:
- If your project becomes inactive or is no longer maintained, clearly communicate this in the README and consider archiving the repository.
By following these guidelines, you contribute to a positive and efficient ecosystem for N3N's hosted projects. Thank you for being part of our community!